 | Float |
Class FloatVector represents a mathematical vector of floating point
numbers.
Inheritance HierarchyNamespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
SyntaxThe FloatVector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FloatVector | Undefined vector. Must be resized before using. |
| FloatVector(DataRow) | Constructs a FloatVector instance whose values are derived from the first column of each of the rows in the double row array. |
| FloatVector(DataRowCollection) | Constructs a FloatVector instance whose values are derived from the first column of each of the rows in the data row collection. |
| FloatVector(DataTable) | Constructs a FloatVector instance whose values are derived from the first column of the given data table. |
| FloatVector(DataView) | Constructs a FloatVector instance whose values are derived from the first column of the given data view. |
| FloatVector(FloatVector) | Constructs a deep copy of a FloatVector. |
| FloatVector(Int32) | Constructs a FloatVector instance with the given length. |
| FloatVector(Single) | Constructs a FloatVector instance from the contents of the given array. |
| FloatVector(String) | Constructs a FloatVector instance from a given string representation. |
| FloatVector(TextReader) | Constructs a FloatVector instance from the given text reader. |
| FloatVector(Int32, RandomNumberGenerator) | Constructs a FloatVector instance from a random number generator. |
| FloatVector(Int32, Single) | Constructs a FloatVector instance with the given length, and all values initialized to the given value. |
| FloatVector(String, NumberStyles) | Returns a new FloatVector instance from a given string representation using the specified style. |
| FloatVector(TextReader, NumberStyles) | Constructs a FloatVector instance from a given text reader using the specified style. |
| FloatVector(FloatDataBlock, Int32, Int32) | Constructs a FloatVector instance with the specifed length, stride and referenced data. |
| FloatVector(Int32, RandomNumberStream, IRandomNumberDistributionSingle) | Constructs a FloatVector instance from a random number generator. |
| FloatVector(Int32, Single, Single) | Constructs a FloatVector instance with the given length. Values are initialized starting with the given initial value, incremented by the specified amount for each element in the vector. |
Properties| Name | Description | |
|---|---|---|
 | DataBlock | Gets a reference to the underlying data that this vector is viewing. |
| ItemInt32 | Gets and sets the data element at the given position. |
 | ItemSlice | Returns a new FloatVector instance pointing to the subset of this vector's data indicated by the given Slice. |
| Length | Gets the number of data elements in this vector. |
| Stride | Gets the step between successive elements in the data that this vector is viewing. |
Methods| Name | Description | |
|---|---|---|
 | Add(FloatVector, FloatVector) | Adds two vectors. |
| Add(FloatVector, Single) | Adds a vector and a scalar. |
| Add(Single, FloatVector) | Adds a scalar and a vector. |
| Add(FloatVector, FloatVector, FloatVector) | Adds two vectors and puts the result into a third vector. |
| Add(FloatVector, Single, FloatVector) | Adds a vector and a scalar and puts the result into another vector. |
| Add(Single, FloatVector, FloatVector) | Adds a scalar and a vector and puts the result into another vector. |
| Append(FloatVector) | Appends the given vector to this vector. |
| Append(Single) | Appends the given element to this vector. |
| Apply(FuncSingle, Single) | Returns a new vector with the same size as this vector, whose values are the result of applying the given unary function to each element of this vector. |
| Apply(FuncSingle, Int32, Single, Int32) | Returns a new vector with the same size as this vector, whose values are the result of applying the given binary function to each element of this vector. The first parameter to the binary function is the vector element; the second parameter is the passed integer value. |
| Apply(FuncSingle, Single, Single, FloatVector) | Returns a new vector with the same size as this vector, whose values are the result of applying the given binary function to each element of this vector. The first parameter to the binary function is an element of self; the second parameter is the corresponding element of the passed vector. |
| Apply(FuncSingle, Single, Single, Single) | Returns a new vector with the same size as this vector, whose values are the result of applying the given binary function to each element of this vector. The first parameter to the binary function is the vector element; the second parameter is the passed floating point value. |
| Clear | Sets the data elements of this vector to zero. |
| Clear(Slice) | Sets the data elements of this vector indicated by the given Slice to zero. |
| Clone | Creates a deep copy of this vector. |
| Decrement | Decrements the elements in a vector. |
| DeepenThisCopy | Guarantees that there is only one reference to the underlying data and that this data is in contiguous storage. |
| Divide(FloatVector, FloatVector) | Divides a vector by another vector. |
| Divide(FloatVector, Single) | Divides a vector by a scalar. |
| Divide(Single, FloatVector) | Divides a scalar by a vector. |
| Divide(FloatVector, FloatVector, FloatVector) | Divides one vector by another vector and puts the result into a third vector. |
| Divide(FloatVector, Single, FloatVector) | Divides a vector by a scalar and puts the result into another vector. |
| Divide(Single, FloatVector, FloatVector) | Divides a scalar by a vector and puts the result into another vector. |
| Equals |
Tests for equality of this vector and another vector. Two vectors are equal
if they have the same dimensions and all values are equal.
(Overrides ObjectEquals(Object)) |
| GetEnumerator | Creates an IEnumerator{float} out of the data elements in this vector. |
| GetFloatEnumerator | Creates an IFloatEnumerator out of the data elements in this vector. |
| GetHashCode |
Returns an integer hash code for this vector.
(Overrides ObjectGetHashCode) |
| GetSchema | The method is reserved and should not be used. |
| Increment(FloatVector) | Increments the elements in a vector. |
| Increment(Single) | Adds the specified value to each element in the vector. |
| InfinityNorm | Computes the infinity-norm of this vector. |
| Multiply(FloatComplex, FloatVector) | Multiplies a complex scalar by a vector. |
| Multiply(FloatVector, FloatComplex) | Multiplies a vector by a complex scalar. |
| Multiply(FloatVector, FloatVector) | Multiplies two vectors. |
| Multiply(FloatVector, Single) | Multiplies a vector with a scalar. |
| Multiply(Single, FloatVector) | Multiplies a scalar with a vector. |
| Multiply(FloatVector, FloatVector, FloatVector) | Multiplies two vectors and puts the result into a third vector. |
| Multiply(FloatVector, Single, FloatVector) | Multiplies a vector and a scalar and puts the result into another vector. |
| Multiply(Single, FloatVector, FloatVector) | Multiplies a scalar and a vector and puts the result into another vector. |
| NaNEquals | Tests for equality of this vector and another vector. Two vectors are equal if they have the same dimensions and all values are equal. |
| Negate | Negates a vector. |
| OneNorm | Computes the 1-norm of this vector. |
| Parse(String) | Returns a new FloatVector instance from a given string representation. |
| Parse(TextReader) | Constructs a FloatVector instance from the given text reader. |
| Parse(String, NumberStyles) | Returns a new FloatVector instance from a given string representation using the specified style. |
| Parse(TextReader, NumberStyles) | Constructs a FloatVector instance from a given text reader using the specified style. |
| ReadXml |
Generates a FloatVector instance form its XML representation.
Example
The vector:
[ 1 2 3 ]
would be serialized as:
|
| Resize | Changes the size of this vector to the specified length, adding zeros or truncating as necessary. |
| ResizeAndClear | Changes the size of this vector to the specified length, and resets the value of all data elements to zero. |
| Reverse | Returns a new vector view of the data in reverse order. |
| Scale | Scales each element in the vector by the specified value. |
| Set(Single) | Sets the data elements of this vector to the specified value. |
| Set(Slice, Single) | Sets the data elements of this vector indicated by the given Slice to the specified value. |
| ShallowCopy | Creates a shallow copy of this vector. |
| Subtract(FloatVector, FloatVector) | Subtracts a vector from a vector. |
| Subtract(FloatVector, Single) | Subtracts a scalar from a vector. |
| Subtract(Single, FloatVector) | Subtracts a vector from a scalar. |
| Subtract(FloatVector, FloatVector, FloatVector) | Subtracts a vector from a second vector and puts the result into a third vector. |
| Subtract(FloatVector, Single, FloatVector) | Subtracts a scalar from a vector and puts the result into another vector. |
| Subtract(Single, FloatVector, FloatVector) | Subtracts a vector from a scalar and puts the result into another vector. |
| ToArray | Copies data into an array and returns it. |
| ToDataTable | Creates a data table of one column that contains the values in this vector. |
| ToDataTable(String) | Creates a data table of one column that contains the values in this vector. |
| ToString |
Returns a formatted string representation of this vector.
(Overrides ObjectToString) |
| ToString(String) | Returns a formatted string representation of this vector. |
| Transform(FuncSingle) | Modifies the elements of this vector by applying the given no-argument function to each element. |
| Transform(FuncSingle, Single) | Modifies the elements of this vector by applying the given unary function to each element. |
| Transform(FuncSingle, Int32, Single, Int32) | Modifies the contents of this vector by applying the given function to each element. The first parameter to the function is the vector element; the second parameter is the passed integer value. |
| Transform(FuncSingle, Single, Single, FloatVector) | Modifies the contents of this vector by applying the given binary function to each element. The first parameter to the binary function is an element of self; the second parameter is the corresponding element of the passed vector. |
| Transform(FuncSingle, Single, Single, Single) | Modifies the contents of this vector by applying the given binary function to each element. The first parameter to the binary function is the vector element; the second parameter is the passed floating point value. |
| TwoNorm | Computes the 2-norm of this vector. |
| TwoNormSquared | Computes the 2-norm squared of this vector. |
| Write(TextWriter) | Writes a text representation of this vector to the given writer. |
| Write(TextWriter, String) | Writes a formatted text representation of this vector. |
| WriteXml |
Converts an object into its XML representation.
Example
The vector:
[ 1 2 3 ]
would be serialized as:
|
Operators| Name | Description | |
|---|---|---|
 | Addition(FloatVector, FloatVector) | Adds two vectors. |
| Addition(FloatVector, Single) | Adds a vector and a scalar. |
| Addition(Single, FloatVector) | Adds a scalar and a vector. |
| Decrement(FloatVector) | Decrements the elements in this vector. |
| Division(FloatVector, FloatVector) | Divides a vector by another vector. |
| Division(FloatVector, Single) | Divides a vector by a scalar. |
| Division(Single, FloatVector) | Divides a scalar by a vector. |
| Equality(FloatVector, FloatVector) | Tests for equality of two vectors. Two vectors are equal if they have the same dimensions and all values are equal. |
| Increment(FloatVector) | Increments the elements in this vector. |
| Inequality(FloatVector, FloatVector) | Tests for inequality of two vectors. Two vectors are unequal if they have different dimensions or their values are not all equal. |
| Multiply(FloatComplex, FloatVector) | Multiplies a complex scalar by a vector. |
| Multiply(FloatVector, FloatComplex) | Multiplies a complex scalar by a vector. |
| Multiply(FloatVector, FloatVector) | Multiplies two vectors. |
| Multiply(FloatVector, Single) | Multiplies a vector by a scalar. |
| Multiply(Single, FloatVector) | Multiplies a scalar by a vector. |
| Subtraction(FloatVector, FloatVector) | Subtracts a vector from another vector. |
| Subtraction(FloatVector, Single) | Subtracts a scalar from a vector. |
| Subtraction(Single, FloatVector) | Subtracts a vector from a scalar. |
| UnaryNegation(FloatVector) | Negates the elements in this vector. |
| UnaryPlus(FloatVector) | Returns a vector. |
Fields| Name | Description | |
|---|---|---|
 | XmlDataElement | XML data element name. |
| XmlDatumElement | XML datum element name. |
| XmlLengthAttribute | XML length attribute name. |
See Also