Header menu logo Deedle

VirtualVectorSource Module

Module that implements various helper operations over `IVirtualVectorSource` type

Types

Type Description

IBoxedVectorSource<'T>

Marks IVirtualVectorSource that has been created by boxing another source

ICombinedVectorSource<'T>

Marks IVirtualVectorSource that has been created by combining another sources

IMappedVectorSource<'T, 'R>

Marks IVirtualVectorSource that has been created by mapping from source

Functions and values

Function or value Description

boxSource source

Full Usage: boxSource source

Parameters:
Returns: IVirtualVectorSource<obj>

Creates a new vector source that boxes all values The result also implements IBoxedVectorSource

source : IVirtualVectorSource<'T>
Returns: IVirtualVectorSource<obj>

combine f sources

Full Usage: combine f sources

Parameters:
Returns: IVirtualVectorSource<'R>

Creates a new vector that combines (zips) vectors using a given function The result also implements ICombinedVectorSource

f : OptionalValue<'T> list -> OptionalValue<'R>
sources : IVirtualVectorSource<'T> list
Returns: IVirtualVectorSource<'R>

createRowReader vectorCtor builder irt vectors sources

Full Usage: createRowReader vectorCtor builder irt vectors sources

Parameters:
Returns: IVirtualVectorSource<IVector<obj>>

Creates a "row reader vector" - that is a vector that provides source for the series returned by frame.Rows. This is combined from a number of sources, but we do not fully materialize anything to create the vector. The first parameter is a ctor for `VirtualVector` which is defined below in the file.

vectorCtor : IVirtualVectorSource<'T> -> IVector
builder : IVectorBuilder
irt : IRowReaderTransform
vectors : IVector<IVector>
sources : IVirtualVectorSource<'T> list
Returns: IVirtualVectorSource<IVector<obj>>

map rev f source

Full Usage: map rev f source

Parameters:
Returns: IVirtualVectorSource<'TNew>

Creates a new vector that transforms source values using a given function The result also implements IMappedVectorSource

rev : ('TNew -> 'V) option
f : IVectorLocation -> OptionalValue<'V> -> OptionalValue<'TNew>
source : IVirtualVectorSource<'V>
Returns: IVirtualVectorSource<'TNew>

Type something to start searching.