Series<'K, 'V> (Deedle)

Series<'K, 'V> Type

Namespace: Deedle
Assembly: Deedle.dll
Base Type: obj
All Interfaces: ISeriesFormattable , IFsiFormattable , ISeries<'K>

The type Series<K, V> represents a data series consisting of values `V` indexed by keys `K`. The keys of a series may or may not be ordered

Other module members
Accessors and slicing
Indexing
Merging, joining and zipping
Operators
Projection and filtering
Resamping
Resampling
Series data
Windowing, chunking and grouping

Other module members

Constructors

Constructor	Description
`Series(keys, values)` Full Usage: `Series(keys, values)` Parameters: keys : `'K[]` values : `'V[]` Returns: `Series<'K, 'V>`	keys : `'K[]` values : `'V[]` Returns: `Series<'K, 'V>`
`Series(keys, values)` Full Usage: `Series(keys, values)` Parameters: keys : `'K seq` values : `'V seq` Returns: `Series<'K, 'V>`	keys : `'K seq` values : `'V seq` Returns: `Series<'K, 'V>`
`Series(pairs)` Full Usage: `Series(pairs)` Parameters: pairs : `KeyValuePair<'K, 'V> seq` Returns: `Series<'K, 'V>`	pairs : `KeyValuePair<'K, 'V> seq` Returns: `Series<'K, 'V>`
`Series(index, vector, vectorBuilder, indexBuilder)` Full Usage: `Series(index, vector, vectorBuilder, indexBuilder)` Parameters: index : `IIndex<'K>` vector : `IVector<'V>` vectorBuilder : `IVectorBuilder` indexBuilder : `IIndexBuilder` Returns: `Series<'K, 'V>`	index : `IIndex<'K>` vector : `IVector<'V>` vectorBuilder : `IVectorBuilder` indexBuilder : `IIndexBuilder` Returns: `Series<'K, 'V>`

Instance members

Instance member	Description
`this.After` Full Usage: `this.After` Parameters: lowerExclusive : `'K` Returns: `Series<'K, 'V>`	lowerExclusive : `'K` Returns: `Series<'K, 'V>`
`this.AsyncMaterialize` Full Usage: `this.AsyncMaterialize` Returns: `Async<Series<'K, 'V>>`	Returns: `Async<Series<'K, 'V>>`
`this.Before` Full Usage: `this.Before` Parameters: upperExclusive : `'K` Returns: `Series<'K, 'V>`	upperExclusive : `'K` Returns: `Series<'K, 'V>`
`this.Between` Full Usage: `this.Between` Parameters: lowerInclusive : `'K` upperInclusive : `'K` Returns: `Series<'K, 'V>`	lowerInclusive : `'K` upperInclusive : `'K` Returns: `Series<'K, 'V>`
`this.EndAt` Full Usage: `this.EndAt` Parameters: upperInclusive : `'K` Returns: `Series<'K, 'V>`	upperInclusive : `'K` Returns: `Series<'K, 'V>`
`this.Format` Full Usage: `this.Format` Parameters: startCount : `int` endCount : `int` showInfo : `bool` Returns: `string`	startCount : `int` endCount : `int` showInfo : `bool` Returns: `string`
`this.Format` Full Usage: `this.Format` Parameters: itemCount : `int` - The total number of items to show. The result will show at most `itemCount/2` items at the beginning and ending of the series. Returns: `string`	Shows the series content in a human-readable format. The resulting string shows a limited number of values from the series. itemCount : `int` The total number of items to show. The result will show at most `itemCount/2` items at the beginning and ending of the series. Returns: `string`
`this.Format` Full Usage: `this.Format` Parameters: showInfo : `bool` Returns: `string`	showInfo : `bool` Returns: `string`
`this.Format` Full Usage: `this.Format` Returns: `string`	Shows the series content in a human-readable format. The resulting string shows a limited number of values from the series. Returns: `string`
`this.FormatStrings` Full Usage: `this.FormatStrings` Parameters: startCount : `int` - The number of elements to show at the beginning of the series endCount : `int` - The number of elements to show at the end of the series Returns: `string[][]`	Shows the series content in a human-readable format. The resulting string shows a limited number of values from the series. startCount : `int` The number of elements to show at the beginning of the series endCount : `int` The number of elements to show at the end of the series Returns: `string[][]`
`this.GetAddressRange` Full Usage: `this.GetAddressRange` Parameters: range : `RangeRestriction<Address>` Returns: `Series<'K, 'V>`	Internal helper used by `skip`, `take`, etc. range : `RangeRestriction<Address>` Returns: `Series<'K, 'V>`
`this.Materialize` Full Usage: `this.Materialize` Returns: `Series<'K, 'V>`	Returns: `Series<'K, 'V>`
`this.MaterializeAsync` Full Usage: `this.MaterializeAsync` Returns: `Task<Series<'K, 'V>>`	Returns: `Task<Series<'K, 'V>>`
`this.StartAt` Full Usage: `this.StartAt` Parameters: lowerInclusive : `'K` Returns: `Series<'K, 'V>`	lowerInclusive : `'K` Returns: `Series<'K, 'V>`

Static members

Static member Description

Static member	Description
`f $ series` Full Usage: `f $ series` Parameters: f : `'V -> 'a` series : `Series<'K, 'V>` Returns: `Series<'K, 'a>`	Custom operator that can be used for applying a function to all elements of a series. This provides a nicer syntactic sugar for the `Series.mapValues` function. For example: // Given a float series and a function on floats let s1 = Series.ofValues [ 1.0 .. 10.0 ] let adjust v = max 10.0 v // Apply "adjust (v + v)" to all elements adjust $ (s1 + s1) f : `'V -> 'a` series : `Series<'K, 'V>` Returns: `Series<'K, 'a>`

Full Usage: f $ series

Parameters:

f : 'V -> 'a

series : Series<'K, 'V>

Returns: Series<'K, 'a>

 Custom operator that can be used for applying a function to all elements of
 a series. This provides a nicer syntactic sugar for the `Series.mapValues`
 function. For example:

     // Given a float series and a function on floats
     let s1 = Series.ofValues [ 1.0 .. 10.0 ]
     let adjust v = max 10.0 v

     // Apply "adjust (v + v)" to all elements
     adjust $ (s1 + s1)

f : 'V -> 'a
series : Series<'K, 'V>

Returns: Series<'K, 'a>

Accessors and slicing

Instance members

Instance member	Description
`this.Get` Full Usage: `this.Get` Parameters: key : `'K` Returns: `'V`	Gets the value at the specified key. Fails if not found. key : `'K` Returns: `'V`
`this.Get` Full Usage: `this.Get` Parameters: key : `'K` lookup : `Lookup` Returns: `'V`	Gets the value at the specified key using the specified lookup semantics. Fails if not found. key : `'K` lookup : `Lookup` Returns: `'V`
`this.GetAt` Full Usage: `this.GetAt` Parameters: index : `int` Returns: `'V`	Gets the value at the specified index position. index : `int` Returns: `'V`
`this.GetByLevel` Full Usage: `this.GetByLevel` Parameters: key : `ICustomLookup<'K>` Returns: `Series<'K, 'V>`	Performs a hierarchical lookup by applying a custom lookup on the series index. key : `ICustomLookup<'K>` Returns: `Series<'K, 'V>`
`this.GetItems` Full Usage: `this.GetItems` Parameters: keys : `'K seq` - A collection of keys in the current series. lookup : `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. Returns: `Series<'K, 'V>`	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`). keys : `'K seq` A collection of keys in the current series. lookup : `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. Returns: `Series<'K, 'V>`
`this.GetItems` Full Usage: `this.GetItems` Parameters: keys : `'K seq` - A collection of keys in the current series. Returns: `Series<'K, 'V>`	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`). keys : `'K seq` A collection of keys in the current series. Returns: `Series<'K, 'V>`
`this.GetKeyAt` Full Usage: `this.GetKeyAt` Parameters: index : `int` Returns: `'K`	Gets the key at the specified index position. index : `int` Returns: `'K`
`this.GetObservation` Full Usage: `this.GetObservation` Parameters: key : `'K` Returns: `KeyValuePair<'K, 'V>`	Gets the value and key at the specified key. Fails if not found. key : `'K` Returns: `KeyValuePair<'K, 'V>`
`this.GetObservation` Full Usage: `this.GetObservation` Parameters: key : `'K` lookup : `Lookup` Returns: `KeyValuePair<'K, 'V>`	Gets the value and key at the specified lookup semantics. Fails if not found. key : `'K` lookup : `Lookup` Returns: `KeyValuePair<'K, 'V>`
`this.GetSlice` Full Usage: `this.GetSlice` Parameters: lo : `'K option` hi : `'K option` Returns: `Series<'K, 'V>`	lo : `'K option` hi : `'K option` Returns: `Series<'K, 'V>`
`this.GetSubrange` Full Usage: `this.GetSubrange` Parameters: lo : `('K * BoundaryBehavior) option` hi : `('K * BoundaryBehavior) option` Returns: `Series<'K, 'V>`	lo : `('K * BoundaryBehavior) option` hi : `('K * BoundaryBehavior) option` Returns: `Series<'K, 'V>`
`this[a]` Full Usage: `this[a]` Parameters: a : `ICustomLookup<'K>` Returns: `Series<'K, 'V>`	Gets values by hierarchical level lookup. a : `ICustomLookup<'K>` Returns: `Series<'K, 'V>`
`this[items]` Full Usage: `this[items]` Parameters: items : `'K seq` Returns: `Series<'K, 'V>`	Gets a series containing values at the specified keys. items : `'K seq` Returns: `Series<'K, 'V>`
`this[a]` Full Usage: `this[a]` Parameters: a : `'K` Returns: `'V`	Gets the value at the specified key. a : `'K` Returns: `'V`
`this.TryGet` Full Usage: `this.TryGet` Parameters: key : `'K` Returns: `OptionalValue<'V>`	Attempts to get the value at the specified key. key : `'K` Returns: `OptionalValue<'V>`
`this.TryGet` Full Usage: `this.TryGet` Parameters: key : `'K` lookup : `Lookup` Returns: `OptionalValue<'V>`	Attempts to get the value at the specified key using the specified lookup semantics. key : `'K` lookup : `Lookup` Returns: `OptionalValue<'V>`
`this.TryGetAt` Full Usage: `this.TryGetAt` Parameters: index : `int` Returns: `OptionalValue<'V>`	Attempts to get the value at the specified index position. index : `int` Returns: `OptionalValue<'V>`
`this.TryGetObservation` Full Usage: `this.TryGetObservation` Parameters: key : `'K` Returns: `OptionalValue<KeyValuePair<'K, OptionalValue<'V>>>`	Attempts to get a value at the specified 'key' key : `'K` Returns: `OptionalValue<KeyValuePair<'K, OptionalValue<'V>>>`
`this.TryGetObservation` Full Usage: `this.TryGetObservation` Parameters: key : `'K` lookup : `Lookup` Returns: `OptionalValue<KeyValuePair<'K, 'V>>`	Attempts to get the value and key at the specified lookup semantics. key : `'K` lookup : `Lookup` Returns: `OptionalValue<KeyValuePair<'K, 'V>>`

Static members

Static member	Description
`series ? name` Full Usage: `series ? name` Parameters: series : `Series<string, 'a>` name : `string` Returns: `'a`	Dynamic operator for accessing series values by key using the `?` syntax. series : `Series<string, 'a>` name : `string` Returns: `'a`

Indexing

Instance members

Instance member	Description
`this.IndexOrdinally` Full Usage: `this.IndexOrdinally` Returns: `Series<int, 'V>`	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. Returns: `Series<int, 'V>`
`this.IndexWith` Full Usage: `this.IndexWith` Parameters: keys : `'TNewKey seq` Returns: `Series<'TNewKey, 'V>`	keys : `'TNewKey seq` Returns: `Series<'TNewKey, 'V>`
`this.Realign` Full Usage: `this.Realign` Parameters: newKeys : `'K seq` Returns: `Series<'K, 'V>`	newKeys : `'K seq` Returns: `Series<'K, 'V>`

Merging, joining and zipping

Instance members

Instance member	Description
`this.Compare` Full Usage: `this.Compare` Parameters: another : `Series<'K, 'V>` Returns: `Series<'K, Diff<'V>>`	another : `Series<'K, 'V>` Returns: `Series<'K, Diff<'V>>`
`this.Intersect` Full Usage: `this.Intersect` Parameters: another : `Series<'K, 'V>` Returns: `Series<'K, 'V>`	another : `Series<'K, 'V>` Returns: `Series<'K, 'V>`
`this.Merge` Full Usage: `this.Merge` Parameters: another : `Series<'K, 'V>` behavior : `UnionBehavior` Returns: `Series<'K, 'V>`	another : `Series<'K, 'V>` behavior : `UnionBehavior` Returns: `Series<'K, 'V>`
`this.Merge` Full Usage: `this.Merge` Parameters: otherSeries : `Series<'K, 'V>[]` Returns: `Series<'K, 'V>`	otherSeries : `Series<'K, 'V>[]` Returns: `Series<'K, 'V>`
`this.Merge` Full Usage: `this.Merge` Parameters: otherSeries : `Series<'K, 'V> seq` Returns: `Series<'K, 'V>`	otherSeries : `Series<'K, 'V> seq` Returns: `Series<'K, 'V>`
`this.Merge` Full Usage: `this.Merge` Parameters: otherSeries : `Series<'K, 'V>` Returns: `Series<'K, 'V>`	otherSeries : `Series<'K, 'V>` Returns: `Series<'K, 'V>`
`this.Replace` Full Usage: `this.Replace` Parameters: key : `'K` - A key to be used for replacing of the series value : `'V` - A value to replace value for `key` Returns: `Series<'K, 'V>`	Replace series values given in keys with value. key : `'K` A key to be used for replacing of the series value : `'V` A value to replace value for `key` Returns: `Series<'K, 'V>`
`this.Replace` Full Usage: `this.Replace` Parameters: keys : `'K[]` - An array of keys to be used for replacing of the series value : `'V` - A value to replace any values for `keys` Returns: `Series<'K, 'V>`	Replace series values given in keys with value. keys : `'K[]` An array of keys to be used for replacing of the series value : `'V` A value to replace any values for `keys` Returns: `Series<'K, 'V>`
`this.Zip` Full Usage: `this.Zip` Parameters: otherSeries : `Series<'K, 'V2>` kind : `JoinKind` lookup : `Lookup` Returns: `Series<'K, ('V opt * 'V2 opt)>`	otherSeries : `Series<'K, 'V2>` kind : `JoinKind` lookup : `Lookup` Returns: `Series<'K, ('V opt * 'V2 opt)>`
`this.Zip` Full Usage: `this.Zip` Parameters: otherSeries : `Series<'K, 'V2>` kind : `JoinKind` Returns: `Series<'K, ('V opt * 'V2 opt)>`	otherSeries : `Series<'K, 'V2>` kind : `JoinKind` Returns: `Series<'K, ('V opt * 'V2 opt)>`
`this.Zip` Full Usage: `this.Zip` Parameters: otherSeries : `Series<'K, 'V2>` Returns: `Series<'K, ('V opt * 'V2 opt)>`	otherSeries : `Series<'K, 'V2>` Returns: `Series<'K, ('V opt * 'V2 opt)>`
`this.ZipInner` Full Usage: `this.ZipInner` Parameters: otherSeries : `Series<'K, 'V2>` Returns: `Series<'K, ('V * 'V2)>`	otherSeries : `Series<'K, 'V2>` Returns: `Series<'K, ('V * 'V2)>`

Operators

Static members

Projection and filtering

Instance members

Instance member	Description
`this.Convert` Full Usage: `this.Convert` Parameters: forward : `Func<'V, 'R>` backward : `Func<'R, 'V>` Returns: `Series<'K, 'R>`	forward : `Func<'V, 'R>` backward : `Func<'R, 'V>` Returns: `Series<'K, 'R>`
`this.Reversed` Full Usage: `this.Reversed` Returns: `Series<'K, 'V>`	Returns: `Series<'K, 'V>`
`this.ScanAllValues` Full Usage: `this.ScanAllValues` Parameters: foldFunc : `Func<OptionalValue<'S>, OptionalValue<'V>, OptionalValue<'S>>` init : `OptionalValue<'S>` Returns: `Series<'K, 'S>`	foldFunc : `Func<OptionalValue<'S>, OptionalValue<'V>, OptionalValue<'S>>` init : `OptionalValue<'S>` Returns: `Series<'K, 'S>`
`this.ScanValues` Full Usage: `this.ScanValues` Parameters: foldFunc : `Func<'S, 'V, 'S>` init : `'S` Returns: `Series<'K, 'S>`	foldFunc : `Func<'S, 'V, 'S>` init : `'S` Returns: `Series<'K, 'S>`
`this.Select` Full Usage: `this.Select` Parameters: f : `Func<KeyValuePair<'K, 'V>, 'R>` Returns: `Series<'K, 'R>`	f : `Func<KeyValuePair<'K, 'V>, 'R>` Returns: `Series<'K, 'R>`
`this.Select` Full Usage: `this.Select` Parameters: f : `Func<KeyValuePair<'K, 'V>, int, 'R>` Returns: `Series<'K, 'R>`	f : `Func<KeyValuePair<'K, 'V>, int, 'R>` Returns: `Series<'K, 'R>`
`this.SelectKeys` Full Usage: `this.SelectKeys` Parameters: f : `Func<KeyValuePair<'K, OptionalValue<'V>>, 'R>` Returns: `Series<'R, 'V>`	f : `Func<KeyValuePair<'K, OptionalValue<'V>>, 'R>` Returns: `Series<'R, 'V>`
`this.SelectOptional` Full Usage: `this.SelectOptional` Parameters: f : `Func<KeyValuePair<'K, OptionalValue<'V>>, OptionalValue<'R>>` Returns: `Series<'K, 'R>`	f : `Func<KeyValuePair<'K, OptionalValue<'V>>, OptionalValue<'R>>` Returns: `Series<'K, 'R>`
`this.SelectValues` Full Usage: `this.SelectValues` Parameters: f : `Func<'V, 'T>` Returns: `Series<'K, 'T>`	f : `Func<'V, 'T>` Returns: `Series<'K, 'T>`
`this.Where` Full Usage: `this.Where` Parameters: f : `Func<KeyValuePair<'K, 'V>, bool>` Returns: `Series<'K, 'V>`	f : `Func<KeyValuePair<'K, 'V>, bool>` Returns: `Series<'K, 'V>`
`this.Where` Full Usage: `this.Where` Parameters: f : `Func<KeyValuePair<'K, 'V>, int, bool>` Returns: `Series<'K, 'V>`	f : `Func<KeyValuePair<'K, 'V>, int, bool>` Returns: `Series<'K, 'V>`
`this.WhereOptional` Full Usage: `this.WhereOptional` Parameters: f : `Func<KeyValuePair<'K, OptionalValue<'V>>, bool>` Returns: `Series<'K, 'V>`	f : `Func<KeyValuePair<'K, OptionalValue<'V>>, bool>` Returns: `Series<'K, 'V>`
`this.WithMissingFrom` Full Usage: `this.WithMissingFrom` Parameters: otherSeries : `Series<'K, 'a>` Returns: `Series<'K, 'V>`	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. otherSeries : `Series<'K, 'a>` Returns: `Series<'K, 'V>`

Resamping

Instance members

Instance member Description

Instance member	Description
`this.Resample` Full Usage: `this.Resample` Parameters: keys : `'K seq` - A collection of keys to be used for resampling of the series direction : `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 : `Func<'K, Series<'K, 'V>, 'a>` - A function that is used to collapse a generated chunk into a single value. Note that this function may be called with empty series. Returns: `Series<'K, '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). This operation is only supported on ordered series. The method throws `InvalidOperationException` when the series is not ordered. keys : `'K seq` A collection of keys to be used for resampling of the series direction : `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 : `Func<'K, Series<'K, 'V>, 'a>` A function that is used to collapse a generated chunk into a single value. Note that this function may be called with empty series. Returns: `Series<'K, 'a>`


                
                  
                    
                      this.Resample

Full Usage: this.Resample

Parameters:

keys : 'K seq - A collection of keys to be used for resampling of the series

direction : 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 : Func<'K, Series<'K, 'V>, 'a> - A function that is used to collapse a generated chunk into a single value. Note that this function may be called with empty series.

Returns: Series<'K, '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).

This operation is only supported on ordered series. The method throws `InvalidOperationException` when the series is not ordered.

keys : 'K seq: A collection of keys to be used for resampling of the series
direction : 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 : Func<'K, Series<'K, 'V>, 'a>: A function that is used to collapse a generated chunk into a single value. Note that this function may be called with empty series.

Returns: Series<'K, 'a>

Resampling

Instance members

Instance member	Description
`this.Resample` Full Usage: `this.Resample` Parameters: keys : `'K seq` - A collection of keys to be used for resampling of the series direction : `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. Returns: `Series<'K, Series<'K, 'V>>`	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. This operation is only supported on ordered series. The method throws `InvalidOperationException` when the series is not ordered. keys : `'K seq` A collection of keys to be used for resampling of the series direction : `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. Returns: `Series<'K, Series<'K, 'V>>`
`this.Resample` Full Usage: `this.Resample` Parameters: keys : `'K seq` - A collection of keys to be used for resampling of the series direction : `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 : `Func<'TNewKey, Series<'K, 'V>, 'R>` - 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 : `Func<'K, Series<'K, 'V>, 'TNewKey>` - A function that is used to generate a new key for each chunk. Returns: `Series<'TNewKey, 'R>`	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). This operation is only supported on ordered series. The method throws `InvalidOperationException` when the series is not ordered. keys : `'K seq` A collection of keys to be used for resampling of the series direction : `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 : `Func<'TNewKey, Series<'K, 'V>, 'R>` 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 : `Func<'K, Series<'K, 'V>, 'TNewKey>` A function that is used to generate a new key for each chunk. Returns: `Series<'TNewKey, 'R>`

Series data

Instance members

Instance member	Description
`this.Index` Full Usage: `this.Index` Returns: `IIndex<'K>`	Returns the index associated with this series. This member should not generally be accessed directly, because all functionality is exposed through series operations. Returns: `IIndex<'K>`
`this.IsEmpty` Full Usage: `this.IsEmpty` Returns: `bool`	Gets a value indicating whether the series is empty. Returns: `bool`
`this.IsOrdered` Full Usage: `this.IsOrdered` Returns: `bool`	Gets a value indicating whether the series index is ordered. Returns: `bool`
`this.KeyCount` Full Usage: `this.KeyCount` Returns: `int`	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. Returns: `int`
`this.KeyRange` Full Usage: `this.KeyRange` Returns: `'K * 'K`	Gets the range of keys in the series. Returns: `'K * 'K`
`this.Keys` Full Usage: `this.Keys` Returns: `'K seq`	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`. Returns: `'K seq`
`this.Observations` Full Usage: `this.Observations` Returns: `KeyValuePair<'K, 'V> seq`	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`. Returns: `KeyValuePair<'K, 'V> seq`
`this.ObservationsAll` Full Usage: `this.ObservationsAll` Returns: `KeyValuePair<'K, OptionalValue<'V>> seq`	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`. Returns: `KeyValuePair<'K, OptionalValue<'V>> seq`
`this.ValueCount` Full Usage: `this.ValueCount` Returns: `int`	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.). Returns: `int`
`this.Values` Full Usage: `this.Values` Returns: `'V seq`	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`. Returns: `'V seq`
`this.ValuesAll` Full Usage: `this.ValuesAll` Returns: `'V seq`	Returns a collection of values, including possibly missing values. Note that the length of this sequence matches the `Keys` sequence. Returns: `'V seq`
`this.Vector` Full Usage: `this.Vector` Returns: `IVector<'V>`	Returns the vector associated with this series. This member should not generally be accessed directly, because all functionality is exposed through series operations. Returns: `IVector<'V>`

Windowing, chunking and grouping

Instance members

Instance member	Description
`this.Aggregate` Full Usage: `this.Aggregate` Parameters: aggregation : `Aggregation<'K>` - Specifies the aggregation method using `Aggregation<K>`. This is a discriminated union listing various chunking and windowing conditions. observationSelector : `Func<DataSegment<Series<'K, 'V>>, KeyValuePair<'TNewKey, OptionalValue<'R>>>` - A function that is called on each chunk to obtain a key and a value. Returns: `Series<'TNewKey, 'R>`	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. aggregation : `Aggregation<'K>` Specifies the aggregation method using `Aggregation<K>`. This is a discriminated union listing various chunking and windowing conditions. observationSelector : `Func<DataSegment<Series<'K, 'V>>, KeyValuePair<'TNewKey, OptionalValue<'R>>>` A function that is called on each chunk to obtain a key and a value. Returns: `Series<'TNewKey, 'R>`
`this.Aggregate` Full Usage: `this.Aggregate` Parameters: aggregation : `Aggregation<'K>` - Specifies the aggregation method using `Aggregation<K>`. This is a discriminated union listing various chunking and windowing conditions. keySelector : `Func<DataSegment<Series<'K, 'V>>, 'TNewKey>` - A function that is called on each chunk to obtain a key. valueSelector : `Func<DataSegment<Series<'K, 'V>>, OptionalValue<'R>>` - A value selector function that is called to aggregate each chunk or window. Returns: `Series<'TNewKey, 'R>`	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`. aggregation : `Aggregation<'K>` Specifies the aggregation method using `Aggregation<K>`. This is a discriminated union listing various chunking and windowing conditions. keySelector : `Func<DataSegment<Series<'K, 'V>>, 'TNewKey>` A function that is called on each chunk to obtain a key. valueSelector : `Func<DataSegment<Series<'K, 'V>>, OptionalValue<'R>>` A value selector function that is called to aggregate each chunk or window. Returns: `Series<'TNewKey, 'R>`
`this.GroupBy` Full Usage: `this.GroupBy` Parameters: keySelector : `Func<KeyValuePair<'K, 'V>, 'TNewKey>` - Generates a new key that is used for aggregation, based on the original key and value. The new key must support equality testing. Returns: `Series<'TNewKey, Series<'K, 'V>>`	Groups a series (ordered or unordered) using the specified key selector (`keySelector`) keySelector : `Func<KeyValuePair<'K, 'V>, 'TNewKey>` Generates a new key that is used for aggregation, based on the original key and value. The new key must support equality testing. Returns: `Series<'TNewKey, Series<'K, 'V>>`
`this.Interpolate` Full Usage: `this.Interpolate` Parameters: keys : `'K seq` - Sequence of new keys that forms the index of interpolated results f : `Func<'K, OptionalValue<KeyValuePair<'K, 'V>>, OptionalValue<KeyValuePair<'K, 'V>>, 'V>` - Function to do the interpolating Returns: `Series<'K, 'V>`	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. keys : `'K seq` Sequence of new keys that forms the index of interpolated results f : `Func<'K, OptionalValue<KeyValuePair<'K, 'V>>, OptionalValue<KeyValuePair<'K, 'V>>, 'V>` Function to do the interpolating Returns: `Series<'K, 'V>`
`this.Pairwise` Full Usage: `this.Pairwise` Returns: `Series<'K, ('V * 'V)>`	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). Returns: `Series<'K, ('V * 'V)>` Example `let input = series [ 1 => 'a'; 2 => 'b'; 3 => 'c'] let res = input.Pairwise() res = series [2 => ('a', 'b'); 3 => ('b', 'c') ]` val input: obj val res: obj
`this.Pairwise` Full Usage: `this.Pairwise` Parameters: boundary : `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. Returns: `Series<'K, DataSegment<'V * 'V>>`	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. boundary : `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. Returns: `Series<'K, DataSegment<'V * 'V>>` Example `let input = series [ 1 => 'a'; 2 => 'b'; 3 => 'c'] let res = input.Pairwise() res = series [2 => ('a', 'b'); 3 => ('b', 'c') ]` val input: obj val res: obj

Static member	Description
`s1 * s2` Full Usage: `s1 * s2` Parameters: s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`s1 * s2` Full Usage: `s1 * s2` Parameters: s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`	s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`
`s1 * s2` Full Usage: `s1 * s2` Parameters: s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`	s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`
`series * scalar` Full Usage: `series * scalar` Parameters: series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`	series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`
`scalar * series` Full Usage: `scalar * series` Parameters: scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`series * scalar` Full Usage: `series * scalar` Parameters: series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`	series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`
`scalar * series` Full Usage: `scalar * series` Parameters: scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`	scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`
`series * scalar` Full Usage: `series * scalar` Parameters: series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`	series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`
`scalar * series` Full Usage: `scalar * series` Parameters: scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`	scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`
`scalar + series` Full Usage: `scalar + series` Parameters: scalar : `string` series : `Series<'K, string>` Returns: `Series<'K, string>`	scalar : `string` series : `Series<'K, string>` Returns: `Series<'K, string>`
`series + scalar` Full Usage: `series + scalar` Parameters: series : `Series<'K, string>` scalar : `string` Returns: `Series<'K, string>`	series : `Series<'K, string>` scalar : `string` Returns: `Series<'K, string>`
`s1 + s2` Full Usage: `s1 + s2` Parameters: s1 : `Series<'K, string>` s2 : `Series<'K, string>` Returns: `Series<'K, string>`	s1 : `Series<'K, string>` s2 : `Series<'K, string>` Returns: `Series<'K, string>`
`s1 + s2` Full Usage: `s1 + s2` Parameters: s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`s1 + s2` Full Usage: `s1 + s2` Parameters: s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`	s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`
`s1 + s2` Full Usage: `s1 + s2` Parameters: s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`	s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`
`series + scalar` Full Usage: `series + scalar` Parameters: series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`	series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`
`scalar + series` Full Usage: `scalar + series` Parameters: scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`series + scalar` Full Usage: `series + scalar` Parameters: series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`	series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`
`scalar + series` Full Usage: `scalar + series` Parameters: scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`	scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`
`series + scalar` Full Usage: `series + scalar` Parameters: series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`	series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`
`scalar + series` Full Usage: `scalar + series` Parameters: scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`	scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`
`s1 - s2` Full Usage: `s1 - s2` Parameters: s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`s1 - s2` Full Usage: `s1 - s2` Parameters: s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`	s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`
`s1 - s2` Full Usage: `s1 - s2` Parameters: s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`	s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`
`series - scalar` Full Usage: `series - scalar` Parameters: series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`	series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`
`scalar - series` Full Usage: `scalar - series` Parameters: scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`series - scalar` Full Usage: `series - scalar` Parameters: series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`	series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`
`scalar - series` Full Usage: `scalar - series` Parameters: scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`	scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`
`series - scalar` Full Usage: `series - scalar` Parameters: series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`	series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`
`scalar - series` Full Usage: `scalar - series` Parameters: scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`	scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`
`s1 / s2` Full Usage: `s1 / s2` Parameters: s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	s1 : `Series<'K, decimal>` s2 : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`s1 / s2` Full Usage: `s1 / s2` Parameters: s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`	s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`
`s1 / s2` Full Usage: `s1 / s2` Parameters: s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`	s1 : `Series<'K, int>` s2 : `Series<'K, int>` Returns: `Series<'K, int>`
`series / scalar` Full Usage: `series / scalar` Parameters: series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`	series : `Series<'K, decimal>` scalar : `decimal` Returns: `Series<'K, decimal>`
`scalar / series` Full Usage: `scalar / series` Parameters: scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	scalar : `decimal` series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`series / scalar` Full Usage: `series / scalar` Parameters: series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`	series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`
`scalar / series` Full Usage: `scalar / series` Parameters: scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`	scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`
`series / scalar` Full Usage: `series / scalar` Parameters: series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`	series : `Series<'K, int>` scalar : `int` Returns: `Series<'K, int>`
`scalar / series` Full Usage: `scalar / series` Parameters: scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`	scalar : `int` series : `Series<'K, int>` Returns: `Series<'K, int>`
`~-series` Full Usage: `~-series` Parameters: series : `Series<'K, int>` Returns: `Series<'K, int>`	series : `Series<'K, int>` Returns: `Series<'K, int>`
`~-series` Full Usage: `~-series` Parameters: series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`	series : `Series<'K, decimal>` Returns: `Series<'K, decimal>`
`~-series` Full Usage: `~-series` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Abs(series)` Full Usage: `Series.Abs(series)` Parameters: series : `Series<'K, int>` Returns: `Series<'K, int>`	series : `Series<'K, int>` Returns: `Series<'K, int>`
`Series.Abs(series)` Full Usage: `Series.Abs(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Acos(series)` Full Usage: `Series.Acos(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Asin(series)` Full Usage: `Series.Asin(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Atan(series)` Full Usage: `Series.Atan(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Ceiling(series)` Full Usage: `Series.Ceiling(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Cos(series)` Full Usage: `Series.Cos(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Cosh(series)` Full Usage: `Series.Cosh(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Exp(series)` Full Usage: `Series.Exp(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Floor(series)` Full Usage: `Series.Floor(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Log(series)` Full Usage: `Series.Log(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Log10(series)` Full Usage: `Series.Log10(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Pow(s1, s2)` Full Usage: `Series.Pow(s1, s2)` Parameters: s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`	s1 : `Series<'K, float>` s2 : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Pow(series, scalar)` Full Usage: `Series.Pow(series, scalar)` Parameters: series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`	series : `Series<'K, float>` scalar : `float` Returns: `Series<'K, float>`
`Series.Pow(scalar, series)` Full Usage: `Series.Pow(scalar, series)` Parameters: scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`	scalar : `float` series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Round(series)` Full Usage: `Series.Round(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Sign(series)` Full Usage: `Series.Sign(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, int>`	series : `Series<'K, float>` Returns: `Series<'K, int>`
`Series.Sin(series)` Full Usage: `Series.Sin(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Sinh(series)` Full Usage: `Series.Sinh(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Sqrt(series)` Full Usage: `Series.Sqrt(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Tan(series)` Full Usage: `Series.Tan(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Tanh(series)` Full Usage: `Series.Tanh(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`
`Series.Truncate(series)` Full Usage: `Series.Truncate(series)` Parameters: series : `Series<'K, float>` Returns: `Series<'K, float>`	series : `Series<'K, float>` Returns: `Series<'K, float>`

Series<'K, 'V> Type

Table of contents

Other module members

Constructors

Instance members

Static members

Accessors and slicing

Instance members

Static members

Indexing

Instance members

Merging, joining and zipping

Instance members

Operators

Static members

Projection and filtering

Instance members

Resamping

Instance members

Resampling

Instance members

Series data

Instance members

Windowing, chunking and grouping

Instance members

Example

Example