ColumnSeriesTRowKey, TColumnKey Class |
Namespace: Deedle
[SerializableAttribute] public class ColumnSeries<TRowKey, TColumnKey> : Series<TColumnKey, ObjectSeries<TRowKey>>
The ColumnSeriesTRowKey, TColumnKey type exposes the following members.
Name | Description | |
---|---|---|
ColumnSeriesTRowKey, TColumnKey(SeriesTColumnKey, ObjectSeriesTRowKey) | Initializes a new instance of the ColumnSeriesTRowKey, TColumnKey class | |
ColumnSeriesTRowKey, TColumnKey(IIndexTColumnKey, IVectorObjectSeriesTRowKey, IVectorBuilder, IIndexBuilder) | Initializes a new instance of the ColumnSeriesTRowKey, TColumnKey class |
Name | Description | |
---|---|---|
Index |
Returns the index associated with this series. This member should not generally
be accessed directly, because all functionality is exposed through series operations.
[category:Series data]
(Inherited from SeriesK, V.) | |
IsEmpty |
[category:Series data]
(Inherited from SeriesK, V.) | |
IsOrdered |
[category:Series data]
(Inherited from SeriesK, V.) | |
ItemIEnumerableTColumnKey | ||
ItemK |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
ItemICustomLookupTColumnKey | ||
KeyCount |
Returns the total number of keys in the specified series. This returns
the total length of the series, including keys for which there is no
value available.
[category:Series data]
(Inherited from SeriesK, V.) | |
KeyRange |
[category:Series data]
(Inherited from SeriesK, V.) | |
Keys |
Returns a collection of keys that are defined by the index of this series.
Note that the length of this sequence does not match the `Values` sequence
if there are missing values. To get matching sequence, use the `Observations`
property or `Series.observation`.
[category:Series data]
(Inherited from SeriesK, V.) | |
Observations |
Returns a collection of observations that form this series. Note that this property
skips over all missing (or NaN) values. Observations are returned as `KeyValuePair<K, V>`
objects. For an F# alternative that uses tuples, see `Series.observations`.
[category:Series data]
(Inherited from SeriesK, V.) | |
ObservationsAll |
Returns a collection of observations that form this series. Note that this property
includes all missing (or NaN) values. Observations are returned as
`KeyValuePair<K, OptionalValue<V>>` objects. For an F# alternative that uses tuples,
see `Series.observationsAll`.
[category:Series data]
(Inherited from SeriesK, V.) | |
Reversed |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
ValueCount |
Returns the total number of values in the specified series. This excludes
missing values or not available values (such as values created from `null`,
`Double.NaN`, or those that are missing due to outer join etc.).
[category:Series data]
(Inherited from SeriesK, V.) | |
Values |
Returns a collection of values that are available in the series data.
Note that the length of this sequence does not match the `Keys` sequence
if there are missing values. To get matching sequence, use the `Observations`
property or `Series.observation`.
[category:Series data]
(Inherited from SeriesK, V.) | |
ValuesAll |
Returns a collection of values, including possibly missing values. Note that
the length of this sequence matches the `Keys` sequence.
[category:Series data]
(Inherited from SeriesK, V.) | |
Vector |
Returns the vector associated with this series. This member should not generally
be accessed directly, because all functionality is exposed through series operations.
[category:Series data]
(Inherited from SeriesK, V.) |
Name | Description | |
---|---|---|
After | (Inherited from SeriesK, V.) | |
AggregateTNewKey, R(AggregationK, FuncDataSegmentSeriesK, V, KeyValuePairTNewKey, OptionalValueR) |
Aggregates an ordered series using the method specified by `Aggregation<K>` and then
applies the provided `observationSelector` on each window or chunk to produce the result
which is returned as a new series. The selector returns both the key and the value.
## Parameters
- `aggregation` - Specifies the aggregation method using `Aggregation<K>`. This is
a discriminated union listing various chunking and windowing conditions.
- `observationSelector` - A function that is called on each chunk to obtain a key and a value.
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
AggregateTNewKey, R(AggregationK, FuncDataSegmentSeriesK, V, TNewKey, FuncDataSegmentSeriesK, V, OptionalValueR) |
Aggregates an ordered series using the method specified by `Aggregation<K>` and then
applies the provided `valueSelector` on each window or chunk to produce the result
which is returned as a new series. A key for each window or chunk is
selected using the specified `keySelector`.
## Parameters
- `aggregation` - Specifies the aggregation method using `Aggregation<K>`. This is
a discriminated union listing various chunking and windowing conditions.
- `keySelector` - A function that is called on each chunk to obtain a key.
- `valueSelector` - A value selector function that is called to aggregate each chunk or window.
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
AsyncMaterialize | (Inherited from SeriesK, V.) | |
Before | (Inherited from SeriesK, V.) | |
Between | (Inherited from SeriesK, V.) | |
ConvertR |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
EndAt | (Inherited from SeriesK, V.) | |
Equals | (Inherited from SeriesK, V.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
Format |
Shows the series content in a human-readable format. The resulting string
shows a limited number of values from the series.
(Inherited from SeriesK, V.) | |
Format(Int32) |
Shows the series content in a human-readable format. The resulting string
shows a limited number of values from the series.
## Parameters
- `itemCount` - The total number of items to show. The result will show
at most `itemCount/2` items at the beginning and ending of the series.
(Inherited from SeriesK, V.) | |
Format(Int32, Int32) |
Shows the series content in a human-readable format. The resulting string
shows a limited number of values from the series.
## Parameters
- `startCount` - The number of elements to show at the beginning of the series
- `endCount` - The number of elements to show at the end of the series
(Inherited from SeriesK, V.) | |
Get(K) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
Get(K, Lookup) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetAddressRange |
Internal helper used by `skip`, `take`, etc.
(Inherited from SeriesK, V.) | |
GetAt |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetByLevel | ||
GetHashCode | (Inherited from SeriesK, V.) | |
GetItems(IEnumerableK) |
Returns a new series with an index containing the specified keys.
When the key is not found in the current series, the newly returned
series will contain a missing value. When the second parameter is not
specified, the keys have to exactly match the keys in the current series
(`Lookup.Exact`).
## Parameters
* `keys` - A collection of keys in the current series.
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetItems(IEnumerableK, Lookup) |
Returns a new series with an index containing the specified keys.
When the key is not found in the current series, the newly returned
series will contain a missing value. When the second parameter is not
specified, the keys have to exactly match the keys in the current series
(`Lookup.Exact`).
## Parameters
* `keys` - A collection of keys in the current series.
* `lookup` - Specifies the lookup behavior when searching for keys in
the current series. `Lookup.NearestGreater` and `Lookup.NearestSmaller`
can be used when the current series is ordered.
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetKeyAt |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetObservation(K) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetObservation(K, Lookup) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetSlice | ||
GetSubrange |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GroupByTNewKey |
Groups a series (ordered or unordered) using the specified key selector (`keySelector`)
## Parameters
- `keySelector` - Generates a new key that is used for aggregation, based on the original
key and value. The new key must support equality testing.
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
IndexOrdinally |
Replace the index of the series with ordinally generated integers starting from zero.
The elements of the series are assigned index according to the current order, or in a
non-deterministic way, if the current index is not ordered.
[category:Indexing]
(Inherited from SeriesK, V.) | |
IndexWithTNewKey |
[category:Indexing]
(Inherited from SeriesK, V.) | |
Interpolate |
Interpolates an ordered series given a new sequence of keys. The function iterates through
each new key, and invokes a function on the current key, the nearest smaller and larger valid
observations from the series argument. The function must return a new valid float.
## Parameters
- `keys` - Sequence of new keys that forms the index of interpolated results
- `f` - Function to do the interpolating
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
Materialize | (Inherited from SeriesK, V.) | |
MaterializeAsync | (Inherited from SeriesK, V.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Merge(SeriesK, V) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
Merge(SeriesK, V) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
Merge(IEnumerableSeriesK, V) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
Merge(SeriesK, V, UnionBehavior) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
Pairwise |
Returns a series containing the predecessor and an element for each input, except
for the first one. The returned series is one key shorter (it does not contain a
value for the first key).
## Parameters
- `series` - The input series to be aggregated.
## Example
let input = series [ 1 => 'a'; 2 => 'b'; 3 => 'c']
let res = input.Pairwise()
res = series [2 => ('a', 'b'); 3 => ('b', 'c') ]
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
Pairwise(Boundary) |
Returns a series containing an element and its neighbor for each input.
The returned series is one key shorter (it does not contain a
value for the first or last key depending on `boundary`). If `boundary` is
other than `Boundary.Skip`, then the key is included in the returned series,
but its value is missing.
## Parameters
- `series` - The input series to be aggregated.
- `boundary` - Specifies the direction in which the series is aggregated and
how the corner case is handled. If the value is `Boundary.AtEnding`, then the
function returns value and its successor, otherwise it returns value and its
predecessor.
## Example
let input = series [ 1 => 'a'; 2 => 'b'; 3 => 'c']
let res = input.Pairwise()
res = series [2 => ('a', 'b'); 3 => ('b', 'c') ]
[category:Windowing, chunking and grouping]
(Inherited from SeriesK, V.) | |
Realign |
[category:Indexing]
(Inherited from SeriesK, V.) | |
Resample(IEnumerableK, Direction) |
Resample the series based on a provided collection of keys. The values of the series
are aggregated into chunks based on the specified keys. Depending on `direction`, the
specified key is either used as the smallest or as the greatest key of the chunk (with
the exception of boundaries that are added to the first/last chunk). The chunks
are then returned as a nested series.
## Parameters
- `keys` - A collection of keys to be used for resampling of the series
- `direction` - If this parameter is `Direction.Forward`, then each key is
used as the smallest key in a chunk; for `Direction.Backward`, the keys are
used as the greatest keys in a chunk.
## Remarks
This operation is only supported on ordered series. The method throws
`InvalidOperationException` when the series is not ordered.
[category:Resampling]
(Inherited from SeriesK, V.) | |
Resamplea(IEnumerableK, Direction, FuncK, SeriesK, V, a) |
Resample the series based on a provided collection of keys. The values of the series
are aggregated into chunks based on the specified keys. Depending on `direction`, the
specified key is either used as the smallest or as the greatest key of the chunk (with
the exception of boundaries that are added to the first/last chunk).
Such chunks are then aggregated using the provided `valueSelector` and `keySelector`
(an overload that does not take `keySelector` just selects the explicitly provided key).
## Parameters
- `keys` - A collection of keys to be used for resampling of the series
- `direction` - If this parameter is `Direction.Forward`, then each key is
used as the smallest key in a chunk; for `Direction.Backward`, the keys are
used as the greatest keys in a chunk.
- `valueSelector` - A function that is used to collapse a generated chunk into a
single value. Note that this function may be called with empty series.
## Remarks
This operation is only supported on ordered series. The method throws
`InvalidOperationException` when the series is not ordered.
[category:Resampling]
(Inherited from SeriesK, V.) | |
ResampleTNewKey, R(IEnumerableK, Direction, FuncTNewKey, SeriesK, V, R, FuncK, SeriesK, V, TNewKey) |
Resample the series based on a provided collection of keys. The values of the series
are aggregated into chunks based on the specified keys. Depending on `direction`, the
specified key is either used as the smallest or as the greatest key of the chunk (with
the exception of boundaries that are added to the first/last chunk).
Such chunks are then aggregated using the provided `valueSelector` and `keySelector`
(an overload that does not take `keySelector` just selects the explicitly provided key).
## Parameters
- `keys` - A collection of keys to be used for resampling of the series
- `direction` - If this parameter is `Direction.Forward`, then each key is
used as the smallest key in a chunk; for `Direction.Backward`, the keys are
used as the greatest keys in a chunk.
- `valueSelector` - A function that is used to collapse a generated chunk into a
single value. Note that this function may be called with empty series.
- `keySelector` - A function that is used to generate a new key for each chunk.
## Remarks
This operation is only supported on ordered series. The method throws
`InvalidOperationException` when the series is not ordered.
[category:Resampling]
(Inherited from SeriesK, V.) | |
ScanAllValuesS |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
ScanValuesS |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
SelectR(FuncKeyValuePairK, V, R) |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
SelectR(FuncKeyValuePairK, V, Int32, R) |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
SelectKeysR |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
SelectOptionalR |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
SelectValuesT |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
StartAt | (Inherited from SeriesK, V.) | |
ToString | (Inherited from SeriesK, V.) | |
TryGet(K) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
TryGet(K, Lookup) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
TryGetAt |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
TryGetObservation(K) |
Attempts to get a value at the specified 'key'
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
TryGetObservation(K, Lookup) |
[category:Accessors and slicing]
(Inherited from SeriesK, V.) | |
Where(FuncKeyValuePairK, V, Boolean) |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
Where(FuncKeyValuePairK, V, Int32, Boolean) |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
WhereOptional |
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
WithMissingFroma |
Returns the current series with the same index but with values missing wherever the
corresponding key exists in the other series index with an associated missing value.
[category:Projection and filtering]
(Inherited from SeriesK, V.) | |
ZipV2(SeriesK, V2) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
ZipV2(SeriesK, V2, JoinKind) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
ZipV2(SeriesK, V2, JoinKind, Lookup) |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) | |
ZipInnerV2 |
[category:Merging, joining and zipping]
(Inherited from SeriesK, V.) |