Header menu logo Deedle

IVirtualVectorSource<'V> Type

Represents a data source for Big Deedle. The interface is used both as a representation of data source for `VirtualVector` (this file) and `VirtualIndex` (another file). The index uses `Length` and `ValueAt` to perform binary search when looking for a key; the vector simply provides an access to values using `ValueAt`.

Instance members

Instance member Description

this.GetSubVector

Full Usage: this.GetSubVector

Parameters:
Returns: IVirtualVectorSource<'V>
Modifiers: abstract

Returns a virtual source for the specified range (used when performing splicing on the frame/series, both using address or using keys - which are obtained using Lookup)

arg0 : RangeRestriction<Address>
Returns: IVirtualVectorSource<'V>

this.LookupRange

Full Usage: this.LookupRange

Parameters:
    arg0 : 'V

Returns: RangeRestriction<Address>
Modifiers: abstract

Find a range (continuous or a sequence of indices) such that all values in the range are the specified value. This is used, for example, when filtering frame based on column value (say column "PClass" has a value "1"). If the data source has some "clever" representation of the range, it can return `Custom of IVectorRange` - which is then passed to `GetSubVector`.

arg0 : 'V
Returns: RangeRestriction<Address>

this.LookupValue

Full Usage: this.LookupValue

Parameters:
Returns: OptionalValue<'V * Address>
Modifiers: abstract

Find the address associated with the specified value. This is used by the index and it has the same signature as `IIndex<'K>.Lookup` (see `Index.fs`).

arg0 : 'V
arg1 : Lookup
arg2 : Func<Address, bool>
Returns: OptionalValue<'V * Address>

this.MergeWith

Full Usage: this.MergeWith

Parameters:
Returns: IVirtualVectorSource<'V>
Modifiers: abstract

Merge the current source with a list of other sources (used by functions such as `Frame.merge` and `Frame.mergeAll`)

arg0 : IVirtualVectorSource<'V> seq
Returns: IVirtualVectorSource<'V>

this.ValueAt

Full Usage: this.ValueAt

Parameters:
Returns: OptionalValue<'V>
Modifiers: abstract

Returns the value at the specifid address. We assume that the address is in range [0L, Length-1L] and that each location has a value (or has a missing value, but is valid)

arg0 : IVectorLocation
Returns: OptionalValue<'V>

Type something to start searching.