nuget
Represents a column of a TypedDataFrame, or a column of a DataFrame that has been mapped.
Typing is validated eagerly, but coercision of particular values is done lazily.
TypedColumn
01 Syntax
Microsoft.VisualBasic.DataStorage.FeatherFormat.TypedColumn`1
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| ToArray | 3 | Converts this column to an array of TColumnType. |
| GetRange | 5 | Converts a subset of this column to an array of TColumnType. |
| GetEnumerator | 1 | IEnumerable.GetEnumerator() |
| TryGetValue | 2 | Sets value to the value of the row at the passed index (in the dataframe's basis). |
| ToArray | 1 | Converts this column to an array of the specified type. |
| GetRange | 2 | Column.GetRange()) |
| TryGetValue | 1 | Column.TryGetValue()) |
| Equals | 1 | Object |
| GetHashCode | 1 | Object |
| ToString | 1 | Object |
| IndexOf | 1 | Finds a given value in the column. |
| LongIndexOf | 1 | Finds a given value in the column. |
| Insert | 1 | Not supported. |
| RemoveAt | 1 | Not supported. |
| Add | 1 | Not supported. |
| Clear | 1 | Not supported. |
| Remove | 1 | Not supported. |
| Contains | 1 | ICollection.Contains()) |
| CopyTo | 1 | ICollection.CopyTo()) |
| op_Explicit | 2 | Equivalent to TypedColumn.ToArray() |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| Index | 1 | Returns the Index (in the appropriate basis) of this column in the original dataframe. |
| Name | 1 | Returns the name of this column. |
| Type | 1 | Returns the .NET equivalent type of this column. |
| Length | 1 | Returns the number of entries in the this column. |
| Count | 1 | IList Throws if TypedColumn.Length will not fit in an int. |
| IsReadOnly | 1 | IList Always return true. |
| Item | 2 | <see cref="this[long]"/> IList |
04 Members
ToArray
Converts this column to an array of TColumnType.
Throws if the column cannot fit in an array.
ToArray(
`0())Converts a subset of this column to an array of TColumnType.
The array is stored at index 0 in the passed array reference, which is initialized or resized if needed.
ToArray(Value())
Converts this column to an array of Value.
Throws if the column cannot fit in an array.
GetRange(
Int64, Int32)Converts a subset of this column to an array of TColumnType.
Throws if the subset cannot fit in an array.
GetRange(
Int64, Int32, `0())Converts a subset of this column to an array of TColumnType.
The column subset starts at the given index (in the dataframe's basis) and is of the given length.
The array is stored at index 0 in the passed array reference, which is initialized or resized if needed.
Throws if the subset cannot fit in an array.
Converts a subset of this column to an array of Value.
The column subset starts at the given index (in the dataframe's basis) and is of the given length.
The array is stored at index 0 in the passed array reference, which is initialized or resized if needed.
GetRange(
Int64, Int32, `0(), Int32)Converts a subset of this column to an array of TColumnType.
The column subset starts at the given index (in the dataframe's basis) and is of the given length.
The array is stored at the given index in the passed array reference, which is initialized or resized if needed.
Throws if the subset cannot fit in an array.
Converts a subset of this column to an array of Value.
The column subset starts at the given index (in the dataframe's basis) and is of the given length.
The array is stored at the given index in the passed array reference, which is initialized or resized if needed.
Throws if the column cannot be coerced to the given type, or the subset cannot fit in an array.
GetEnumerator
IEnumerable.GetEnumerator()
TryGetValue(
Int64, `0)Sets value to the value of the row at the passed index (in the dataframe's basis).
If the passed index is out of bounds false is returned. Otherwise, true is returned;
TryGetValue(
Int64, Value)ToArray``1(
``0())Converts this column to an array of the specified type.
Throws if the column cannot be coerced to the given type, or cannot fit in an array.
GetRange``1(
Int64, Int32, ``0())GetRange``1(
Int64, Int32, ``0(), Int32)TryGetValue``1(
Int64, ``0)Equals(
Object)Object
GetHashCode
Object
ToString
Object
IndexOf(
`0)Finds a given value in the column. Throws if the index will not fit in an int.
LongIndexOf(
`0)Finds a given value in the column.
Insert(
Int32, `0)Not supported.
RemoveAt(
Int32)Not supported.
Add(
`0)Not supported.
Clear
Not supported.
Remove(
`0)Not supported.
Contains(
`0)ICollection.Contains()
CopyTo(
`0(), Int32)ICollection.CopyTo()
op_Explicit(TypedColumn(Of `0))
Equivalent to TypedColumn.ToArray()
op_Explicit(TypedColumn(Of `0))
Equivalent to TypedColumn.ToArray()
Index
Returns the Index (in the appropriate basis) of this column in the original dataframe.
Name
Returns the name of this column.
Type
Returns the .NET equivalent type of this column.
Length
Returns the number of entries in the this column. This will always match the number of rows in the original dataframe.
Count
IList
Throws if TypedColumn.Length will not fit in an int.
IsReadOnly
IList
Always return true.
Item(
Int32)<see cref="this[long]"/> IList
Item(
Int64)Return the value at the given index.
Will throw if the index is out of bounds. Use TypedColumn.TryGetValue() for non-throwing gets.
Parameters
| Name | Type | Description |
|---|---|---|
rowIndex | Int64 | The index of the value to get, in the appropriate basis. |