DoubleMatrix Type

Namespace: Altaxo.Calc.LinearAlgebra
Assembly: AltaxoCore.Redist.dll
Base Type: obj
All Interfaces: IMatrix<float> , ICloneable , IFormattable , IList , ICollection , IEnumerable , IMatrixLevel1<float> , IROMatrixLevel1<float> , IROMatrix<float>

Defines a matrix of doubles.

Copyright (c) 2003-2004, dnAnalytics Project. All rights reserved. See http://www.dnAnalytics.net for details.

Adopted to Altaxo (c) 2005 Dr. Dirk Lellinger.

Constructors

Constructor Description

DoubleMatrix(dimension)

Full Usage: DoubleMatrix(dimension)

Parameters:
    dimension : int - Dimensions of square matrix.

Constructor for square matrix with its components set to zero.

dimension : int

Dimensions of square matrix.

ArgumentException dimension isn't positive.

DoubleMatrix(rows, columns)

Full Usage: DoubleMatrix(rows, columns)

Parameters:
    rows : int - Number of rows.
    columns : int - Number of columns.

Constructor for matrix with its components set to zero.

rows : int

Number of rows.

columns : int

Number of columns.

ArgumentException dimensions aren't positive.

DoubleMatrix(dimension, value)

Full Usage: DoubleMatrix(dimension, value)

Parameters:
    dimension : int - Dimensions of square matrix.
    value : float - double value to fill all matrix components.

Constructor for square matrix with its components set to a specified value.

dimension : int

Dimensions of square matrix.

value : float

double value to fill all matrix components.

ArgumentException dimension parameter isn't positive

DoubleMatrix(rows, columns, value)

Full Usage: DoubleMatrix(rows, columns, value)

Parameters:
    rows : int - Number of rows.
    columns : int - Number of columns.
    value : float - double value to fill all matrix components.

Constructor for matrix with components set to a specified value

rows : int

Number of rows.

columns : int

Number of columns.

value : float

double value to fill all matrix components.

ArgumentException dimension parameters aren't positive

DoubleMatrix(source)

Full Usage: DoubleMatrix(source)

Parameters:
    source : DoubleMatrix - DoubleMatrix to deep copy into new matrix.

Constructor for matrix that makes a deep copy of a given double matrix.

source : DoubleMatrix

DoubleMatrix to deep copy into new matrix.

ArgumentNullException source is null.

DoubleMatrix(source)

Full Usage: DoubleMatrix(source)

Parameters:
    source : FloatMatrix - DoubleMatrix to deep copy into new matrix.

Constructor for matrix that makes a deep copy of a given double matrix.

source : FloatMatrix

DoubleMatrix to deep copy into new matrix.

ArgumentNullException source is null.

DoubleMatrix(values)

Full Usage: DoubleMatrix(values)

Parameters:
    values : float[,]

values : float[,]

DoubleMatrix(values)

Full Usage: DoubleMatrix(values)

Parameters:
    values : float32[,]

values : float32[,]

DoubleMatrix(source)

Full Usage: DoubleMatrix(source)

Parameters:
    source : IROMatrix<float> - IROMatrix to deep copy into new matrix.

Constructor for matrix that makes a deep copy of a given IROMatrix.

source : IROMatrix<float>

IROMatrix to deep copy into new matrix.

ArgumentNullException source is null.

Instance members

Instance member Description

this.Add

Full Usage: this.Add

Parameters:

Add a DoubleMatrix to thisDoubleMatrix

a : DoubleMatrix

DoubleMatrix to add.

ArgumentException matrices are not conformable.
ArgumentNullException matrix is null.

this.Add

Full Usage: this.Add

Parameters:
    a : float - double to add.

Add a double to thisDoubleMatrix.

a : float

double to add.

this.Add

Full Usage: this.Add

Parameters:
    value : obj

Returns: int
Modifiers: abstract

Add a new value to the end of the DoubleVector

value : obj
Returns: int

this.Clear

Full Usage: this.Clear

Modifiers: abstract

Set all values in the DoubleVector to zero

this.Clone

Full Usage: this.Clone

Returns: DoubleMatrix

Clone (deep copy) a DoubleMatrix variable.

Returns: DoubleMatrix

this.ColumnCount

Full Usage: this.ColumnCount

Returns: int The number of columns.
Modifiers: abstract

Return the number of columns in DoubleMatrix variable.

Returns: int

The number of columns.

this.ColumnLength

Full Usage: this.ColumnLength

Returns: int The number of columns.

Return the number of columns in DoubleMatrix variable.

Returns: int

The number of columns.

this.Contains

Full Usage: this.Contains

Parameters:
    value : obj

Returns: bool
Modifiers: abstract

Check if the any of the DoubleVector components equals a given double

value : obj
Returns: bool

this.Copy

Full Usage: this.Copy

Parameters:

Copies the values from a matrix into this matrix.

x : DoubleMatrix

The matrix to copy the values from.

ArgumentNullException matrix is null.

this.CopyFrom

Full Usage: this.CopyFrom

Parameters:

x : DoubleMatrix

this.CopyFrom

Full Usage: this.CopyFrom

Parameters:
Modifiers: abstract

from : IROMatrix<float>

this.CopyTo

Full Usage: this.CopyTo

Parameters:
    array : Array
    index : int

Copy the components of this vector to an array

array : Array
index : int

this.Count

Full Usage: this.Count

Returns: int

Get the number of elements in the matrix

Returns: int

this.Divide

Full Usage: this.Divide

Parameters:
    a : float - double to divide by (as denominator).

Divide this DoubleMatrix's elements with a double

a : float

double to divide by (as denominator).

this.EnumerateElementsIndexed

Full Usage: this.EnumerateElementsIndexed

Parameters:
Returns: IEnumerable<int * int * float>
Modifiers: abstract

?zeros : Zeros
Returns: IEnumerable<int * int * float>

this.Equals

Full Usage: this.Equals

Parameters:
    obj : obj - obj to compare present DoubleMatrix to.

Returns: bool Returns true if the variable is the same as the DoubleMatrix variable
Modifiers: abstract

Check if DoubleMatrix variable is the same as another object.

obj : obj

obj to compare present DoubleMatrix to.

Returns: bool

Returns true if the variable is the same as the DoubleMatrix variable

this.GetColumn

Full Usage: this.GetColumn

Parameters:
    column : int - Column number to return.

Returns: DoubleVector DoubleVector representation of column from the DoubleMatrix.

Return a column of the DoubleMatrix as a DoubleVector.

column : int

Column number to return.

Returns: DoubleVector

DoubleVector representation of column from the DoubleMatrix.

this.GetColumn

Full Usage: this.GetColumn

Parameters:
    columnNumber : int - Number of column of the matrix to be copied.
    destinationVector : IVector<float> - Vector to copy the column data to.

Gets the column of a matrix copied into a vector.

columnNumber : int

Number of column of the matrix to be copied.

destinationVector : IVector<float>

Vector to copy the column data to.

this.GetConditionNumber

Full Usage: this.GetConditionNumber

Returns: float the condition number of the matrix.

Calculates the condition number of the matrix.

Returns: float

the condition number of the matrix.

NotSquareMatrixException the matrix is not square.

this.GetDeterminant

Full Usage: this.GetDeterminant

Returns: float The determinant the DoubleMatrix.

Computes the determinant the DoubleMatrix.

Returns: float

The determinant the DoubleMatrix.

NotSquareMatrixException the matrix is not square.

this.GetDiagonal

Full Usage: this.GetDiagonal

Returns: DoubleVector DoubleVector representation of diagonal from the DoubleMatrix.

Return the diagonal of the DoubleMatrix as a DoubleVector.

Returns: DoubleVector

DoubleVector representation of diagonal from the DoubleMatrix.

this.GetEnumerator

Full Usage: this.GetEnumerator

Returns: IEnumerator
Modifiers: abstract

Return an IEnumerator

Returns: IEnumerator

this.GetFrobeniusNorm

Full Usage: this.GetFrobeniusNorm

Returns: float the Frobenius norm of this matrix.

Calculates the Frobenius norm of this matrix.

Returns: float

the Frobenius norm of this matrix.

this.GetHashCode

Full Usage: this.GetHashCode

Returns: int The Hashcode representation of DoubleMatrix
Modifiers: abstract

Return the Hashcode for the DoubleMatrix

Returns: int

The Hashcode representation of DoubleMatrix

this.GetInfinityNorm

Full Usage: this.GetInfinityNorm

Returns: float the infinity norm of this matrix.

Calculates the infinity norm of this matrix.

Returns: float

the infinity norm of this matrix.

this.GetInverse

Full Usage: this.GetInverse

Returns: DoubleMatrix The inverse of the DoubleMatrix.

Returns an inverse of the DoubleMatrix

Returns: DoubleMatrix

The inverse of the DoubleMatrix.

SingularMatrixException the matrix is singular.
NotSquareMatrixException the matrix is not square.

this.GetL1Norm

Full Usage: this.GetL1Norm

Returns: float the L1 norm of this matrix.

Calculates the L1 norm of this matrix.

Returns: float

the L1 norm of this matrix.

this.GetL2Norm

Full Usage: this.GetL2Norm

Returns: float the L2 norm of this matrix.

Calculates the L2 norm of this matrix.

Returns: float

the L2 norm of this matrix.

this.GetLowerTriangle

Full Usage: this.GetLowerTriangle

Returns: DoubleMatrix DoubleMatrix with lower triangle values from DoubleMatrix.

Return the lower triangle values from DoubleMatrix.

Returns: DoubleMatrix

DoubleMatrix with lower triangle values from DoubleMatrix.

this.GetRow

Full Usage: this.GetRow

Parameters:
    row : int - Row number to return.

Returns: DoubleVector DoubleVector representation of row from the DoubleMatrix.

Return a row of the DoubleMatrix as a DoubleVector.

row : int

Row number to return.

Returns: DoubleVector

DoubleVector representation of row from the DoubleMatrix.

this.GetStrictlyLowerTriangle

Full Usage: this.GetStrictlyLowerTriangle

Returns: DoubleMatrix DoubleMatrix with strictly lower triangle values from DoubleMatrix.

Return the strictly lower triangle values from DoubleMatrix.

Returns: DoubleMatrix

DoubleMatrix with strictly lower triangle values from DoubleMatrix.

this.GetStrictlyUpperTriangle

Full Usage: this.GetStrictlyUpperTriangle

Returns: DoubleMatrix DoubleMatrix with strictly upper triangle values from DoubleMatrix.

Return the strictly upper triangle values from DoubleMatrix.

Returns: DoubleMatrix

DoubleMatrix with strictly upper triangle values from DoubleMatrix.

this.GetSubMatrix

Full Usage: this.GetSubMatrix

Parameters:
    startRow : int - Return data from this row to last row.
    startColumn : int - Return data from this column to last column.

Returns: DoubleMatrix DoubleMatrix of submatrix specified by input variable.

Returns a submatrix of the DoubleMatrix.

startRow : int

Return data from this row to last row.

startColumn : int

Return data from this column to last column.

Returns: DoubleMatrix

DoubleMatrix of submatrix specified by input variable.

ArgumentException input dimensions exceed those of DoubleMatrix.
ArgumentOutOfRangeException input dimensions are out of the range of DoubleMatrix dimensions.

this.GetSubMatrix

Full Usage: this.GetSubMatrix

Parameters:
    startRow : int - Return data starting from this row.
    startColumn : int - Return data starting from this column.
    endRow : int - Return data ending in this row.
    endColumn : int - Return data ending in this column.

Returns: DoubleMatrix DoubleMatrix of submatrix specified by input variable.

Returns a submatrix of the DoubleMatrix.

startRow : int

Return data starting from this row.

startColumn : int

Return data starting from this column.

endRow : int

Return data ending in this row.

endColumn : int

Return data ending in this column.

Returns: DoubleMatrix

DoubleMatrix of submatrix specified by input variable.

ArgumentException input dimensions exceed those of DoubleMatrix.
ArgumentOutOfRangeException input dimensions are out of the range ofDoubleMatrix dimensions.

this.GetTranspose

Full Usage: this.GetTranspose

Returns: DoubleMatrix The transpose of the DoubleMatrix.

Return the transpose of the DoubleMatrix.

Returns: DoubleMatrix

The transpose of the DoubleMatrix.

this.GetUpperTriangle

Full Usage: this.GetUpperTriangle

Returns: DoubleMatrix DoubleMatrix with upper triangle values from DoubleMatrix.

Return the upper triangle values from DoubleMatrix.

Returns: DoubleMatrix

DoubleMatrix with upper triangle values from DoubleMatrix.

this.IndexOf

Full Usage: this.IndexOf

Parameters:
    value : obj

Returns: int
Modifiers: abstract

Return the index of the xDoubleVector for the first component that equals a given double

value : obj
Returns: int

this.Insert

Full Usage: this.Insert

Parameters:
    index : int
    value : obj

Modifiers: abstract

Insert a double into the DoubleVector at a given index

index : int
value : obj

this.InternalData

Full Usage: this.InternalData

Returns: MatrixWrapperStructForLeftSpineJaggedArray<float>

Gets the internal data of this matrix, i.e. the left spine jagged array, along with the number of rows and columns of the matrix

Returns: MatrixWrapperStructForLeftSpineJaggedArray<float>

this.Invert

Full Usage: this.Invert

Inverts the DoubleMatrix.

SingularMatrixException the matrix is singular.
NotSquareMatrixException the matrix is not square.

this.IsFixedSize

Full Usage: this.IsFixedSize

Returns: bool
Modifiers: abstract

Returns true indicating that the IList interface doesn't support addition and removal of elements

Returns: bool

this.IsReadOnly

Full Usage: this.IsReadOnly

Returns: bool
Modifiers: abstract

Returns false indicating that the IList interface supports modification of elements

Returns: bool

this.IsSynchronized

Full Usage: this.IsSynchronized

Returns: bool

Get a boolean indicating whether the data storage method of this vector is thread-safe

Returns: bool

this.[arg1, arg2]

Full Usage: this.[arg1, arg2]

Parameters:
    arg0 : int

Returns: int Returns a double matrix element.
Modifiers: abstract

Access a matrix element.

arg0 : int
Returns: int

Returns a double matrix element.

ArgumentOutOfRangeException element accessed is out of the bounds of the matrix.

this.MapIndexed

Full Usage: this.MapIndexed

Parameters:
    function : Func<int, int, float, float>
    result : IMatrix<float>
    ?zeros : Zeros

Modifiers: abstract

function : Func<int, int, float, float>
result : IMatrix<float>
?zeros : Zeros

this.MapIndexed

Full Usage: this.MapIndexed

Parameters:
    sourceParameter1 : 'T1
    function : Func<int, int, float, 'T1, float>
    result : IMatrix<float>
    ?zeros : Zeros

Modifiers: abstract
Type parameters: 'T1

sourceParameter1 : 'T1
function : Func<int, int, float, 'T1, float>
result : IMatrix<float>
?zeros : Zeros

this.Multiply

Full Usage: this.Multiply

Parameters:
    a : float - double to multiply with.

Multiply this DoubleMatrix's elements with a double.

a : float

double to multiply with.

this.Multiply

Full Usage: this.Multiply

Parameters:

Multiply this DoubleMatrix with a DoubleVector and return results in this DoubleMatrix.

a : DoubleVector

DoubleVector to act as right operator.

ArgumentException Exception thrown if parameter dimensions are not conformable.
ArgumentNullException x is null.

this.Multiply

Full Usage: this.Multiply

Parameters:

Multiply this DoubleMatrix with a DoubleMatrix and return results in this DoubleMatrix

a : DoubleMatrix

DoubleMatrix to act as right operator.

ArgumentException dimensions are not conformable.
ArgumentNullException x is null.

this.Remove

Full Usage: this.Remove

Parameters:
    value : obj

Modifiers: abstract

Remove the first instance of a given double from the DoubleVector

value : obj

this.RemoveAt

Full Usage: this.RemoveAt

Parameters:
    index : int

Modifiers: abstract

Remove the component of the DoubleVector at a given index

index : int

this.RowCount

Full Usage: this.RowCount

Returns: int The number of rows.
Modifiers: abstract

Return the number of rows in the DoubleMatrix variable.

Returns: int

The number of rows.

this.RowLength

Full Usage: this.RowLength

Returns: int The number of rows.

Return the number of rows in the DoubleMatrix variable.

Returns: int

The number of rows.

this.SetColumn

Full Usage: this.SetColumn

Parameters:
    column : int - The column to set.
    data : DoubleVector - The data to file the column with.

Sets the values of a column to the given vector.

column : int

The column to set.

data : DoubleVector

The data to file the column with.

this.SetColumn

Full Usage: this.SetColumn

Parameters:
    column : int - The column to set.
    data : float[] - The data to file the column with.

Sets the values of a column to the given array.

column : int

The column to set.

data : float[]

The data to file the column with.

this.SetDiagonal

Full Usage: this.SetDiagonal

Parameters:
    source : DoubleVector - DoubleVector with values to insert into diagonal of DoubleMatrix.

Set the diagonal of the DoubleMatrix to the values in a DoubleVector variable.

source : DoubleVector

DoubleVector with values to insert into diagonal of DoubleMatrix.

this.SetDiagonal

Full Usage: this.SetDiagonal

Parameters:
    source : IReadOnlyList<float> - DoubleVector with values to insert into diagonal of DoubleMatrix.

Set the diagonal of the DoubleMatrix to the values in a DoubleVector variable.

source : IReadOnlyList<float>

DoubleVector with values to insert into diagonal of DoubleMatrix.

this.SetRow

Full Usage: this.SetRow

Parameters:
    row : int - The row to set.
    data : DoubleVector - The data to file the row with.

Sets the values of a row to the given vector.

row : int

The row to set.

data : DoubleVector

The data to file the row with.

this.SetRow

Full Usage: this.SetRow

Parameters:
    row : int - The row to set.
    data : float[] - The data to file the row with.

Sets the values of a row to the given array.

row : int

The row to set.

data : float[]

The data to file the row with.

this.Subtract

Full Usage: this.Subtract

Parameters:

Subtract a DoubleMatrix from this DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to subtract.

ArgumentNullException matrix is null.

this.Subtract

Full Usage: this.Subtract

Parameters:
    a : float - double to subtract.

Subtract a double from this DoubleMatrix

a : float

double to subtract.

this.ToArray

Full Usage: this.ToArray

Returns: float[,] double array with data from DoubleMatrix.

Convert DoubleMatrix into double array

Returns: float[,]

double array with data from DoubleMatrix.

this.ToROMatrix

Full Usage: this.ToROMatrix

Returns: IROMatrix<float>

Returns: IROMatrix<float>

this.ToString

Full Usage: this.ToString

Returns: string The string representation of the value of this instance.
Modifiers: abstract

A string representation of this DoubleMatrix.

Returns: string

The string representation of the value of this instance.

this.ToString

Full Usage: this.ToString

Parameters:
    format : string - A format specification.

Returns: string The string representation of the value of this instance as specified by format.

A string representation of this DoubleMatrix.

format : string

A format specification.

Returns: string

The string representation of the value of this instance as specified by format.

this.ToString

Full Usage: this.ToString

Parameters:
    formatProvider : IFormatProvider - An IFormatProvider that supplies culture-specific formatting information.

Returns: string The string representation of the value of this instance as specified by provider.

A string representation of this DoubleMatrix.

formatProvider : IFormatProvider

An IFormatProvider that supplies culture-specific formatting information.

Returns: string

The string representation of the value of this instance as specified by provider.

this.ToString

Full Usage: this.ToString

Parameters:
    format : string - A format specification.
    formatProvider : IFormatProvider - An IFormatProvider that supplies culture-specific formatting information.

Returns: string The string representation of the value of this instance as specified by format and provider.
Modifiers: abstract

A string representation of this DoubleMatrix.

format : string

A format specification.

formatProvider : IFormatProvider

An IFormatProvider that supplies culture-specific formatting information.

Returns: string

The string representation of the value of this instance as specified by format and provider.

this.Transpose

Full Usage: this.Transpose

Replace the DoubleMatrix with its transpose.

Static members

Static member Description

a * b

Full Usage: a * b

Parameters:
    a : float - double to act as left operator.
    b : DoubleMatrix - DoubleMatrix to act as right operator.

Returns: DoubleMatrix DoubleMatrix with results.

Multiply a DoubleMatrix's elements with a double.

a : float

double to act as left operator.

b : DoubleMatrix

DoubleMatrix to act as right operator.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a * b

Full Usage: a * b

Parameters:
    a : DoubleMatrix - DoubleMatrix whose elements to multiply.
    b : float - double to multiply with.

Returns: DoubleMatrix DoubleMatrix with results.

Multiply a DoubleMatrix's elements with a double.

a : DoubleMatrix

DoubleMatrix whose elements to multiply.

b : float

double to multiply with.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a * b

Full Usage: a * b

Parameters:
Returns: DoubleVector DoubleMatrix with results

Multiply a DoubleMatrix with a DoubleVector

a : DoubleMatrix

DoubleMatrix to act as left operator.

b : DoubleVector

DoubleVector to act as right operator.

Returns: DoubleVector

DoubleMatrix with results

ArgumentException dimensions are not conformable.
ArgumentNullException either matrix or vector is null.

a * b

Full Usage: a * b

Parameters:
Returns: DoubleMatrix DoubleMatrix with results.

Multiply a DoubleMatrix with a DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to act as left operator.

b : DoubleMatrix

DoubleMatrix to act as right operator.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentException dimensions are not conformable.
ArgumentNullException either matrix is null.

a + b

Full Usage: a + b

Parameters:
Returns: DoubleMatrix DoubleMatrix with results.

Add a DoubleMatrix to another DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to add to.

b : DoubleMatrix

DoubleMatrix to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException either matrix is null.

a + b

Full Usage: a + b

Parameters:
    a : float - double to add to.
    b : DoubleMatrix - DoubleMatrix to add.

Returns: DoubleMatrix DoubleMatrix with results.

Add a double to a DoubleMatrix.

a : float

double to add to.

b : DoubleMatrix

DoubleMatrix to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a + b

Full Usage: a + b

Parameters:
    a : DoubleMatrix - DoubleMatrix to add to.
    b : float - double to add.

Returns: DoubleMatrix DoubleMatrix with results.

Add a DoubleMatrix to a double.

a : DoubleMatrix

DoubleMatrix to add to.

b : float

double to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a - b

Full Usage: a - b

Parameters:
Returns: DoubleMatrix DoubleMatrix with results.

Subtract a DoubleMatrix from another DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to subtract from.

b : DoubleMatrix

DoubleMatrix to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException either matrix is null.

a - b

Full Usage: a - b

Parameters:
    a : float - double to subtract from.
    b : DoubleMatrix - DoubleMatrix to subtract.

Returns: DoubleMatrix DoubleMatrix with results.

Subtract a DoubleMatrix from a double.

a : float

double to subtract from.

b : DoubleMatrix

DoubleMatrix to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a - b

Full Usage: a - b

Parameters:
    a : DoubleMatrix - DoubleMatrix to subtract from.
    b : float - double to subtract.

Returns: DoubleMatrix DoubleMatrix with results.

Subtract a double from a DoubleMatrix

a : DoubleMatrix

DoubleMatrix to subtract from.

b : float

double to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

a / b

Full Usage: a / b

Parameters:
    a : DoubleMatrix - DoubleMatrix whose elements to divide as numerator.
    b : float - double to divide by (as denominator).

Returns: DoubleMatrix DoubleMatrix with results.

Divide a DoubleMatrix's elements with a double.

a : DoubleMatrix

DoubleMatrix whose elements to divide as numerator.

b : float

double to divide by (as denominator).

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

~+a

Full Usage: ~+a

Parameters:
Returns: DoubleMatrix DoubleMatrix with values to return

Positive operator for DoubleMatrix

a : DoubleMatrix
Returns: DoubleMatrix

DoubleMatrix with values to return

ArgumentNullException matrix is null.

~-a

Full Usage: ~-a

Parameters:
Returns: DoubleMatrix DoubleMatrix with values to negate.

Negate operator for DoubleMatrix.

a : DoubleMatrix
Returns: DoubleMatrix

DoubleMatrix with values to negate.

ArgumentNullException matrix is null.

DoubleMatrix.Add(a, b)

Full Usage: DoubleMatrix.Add(a, b)

Parameters:
Returns: DoubleMatrix DoubleMatrix with results.

Add a DoubleMatrix to another DoubleMatrix,

a : DoubleMatrix

DoubleMatrix to add to.

b : DoubleMatrix

DoubleMatrix to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException either matrix is null.

DoubleMatrix.Add(a, b)

Full Usage: DoubleMatrix.Add(a, b)

Parameters:
    a : float - double to add to.
    b : DoubleMatrix - DoubleMatrix to add.

Returns: DoubleMatrix DoubleMatrix with results.

Add a double to a DoubleMatrix,

a : float

double to add to.

b : DoubleMatrix

DoubleMatrix to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.Add(a, b)

Full Usage: DoubleMatrix.Add(a, b)

Parameters:
    a : DoubleMatrix - DoubleMatrix to add to.
    b : float - double to add.

Returns: DoubleMatrix DoubleMatrix with results.

Add a DoubleMatrix to a double,

a : DoubleMatrix

DoubleMatrix to add to.

b : float

double to add.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.CreateIdentity(rank)

Full Usage: DoubleMatrix.CreateIdentity(rank)

Parameters:
    rank : int - Rank of identity matrix.

Returns: DoubleMatrix

Creates an identity matrix.

rank : int

Rank of identity matrix.

Returns: DoubleMatrix

DoubleMatrix.CreateIdentity(rows, columns)

Full Usage: DoubleMatrix.CreateIdentity(rows, columns)

Parameters:
    rows : int - The number of rows.
    columns : int - The number of columns.

Returns: DoubleMatrix

Creates a matrix where the diagonal m[i,i] is set to 1. The matrix must not neccessarily be a square matrix.

rows : int

The number of rows.

columns : int

The number of columns.

Returns: DoubleMatrix

DoubleMatrix.Diag(v)

Full Usage: DoubleMatrix.Diag(v)

Parameters:
Returns: DoubleMatrix

v : IReadOnlyList<float>
Returns: DoubleMatrix

DoubleMatrix.Divide(a, b)

Full Usage: DoubleMatrix.Divide(a, b)

Parameters:
    a : DoubleMatrix - DoubleMatrix whose elements to divide as numerator.
    b : float - double to divide by (as denominator).

Returns: DoubleMatrix DoubleMatrix with results.

Divide a DoubleMatrix's elements with a double.

a : DoubleMatrix

DoubleMatrix whose elements to divide as numerator.

b : float

double to divide by (as denominator).

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.FromProductOf(x, y)

Full Usage: DoubleMatrix.FromProductOf(x, y)

Parameters:
Returns: DoubleMatrix

x : IReadOnlyList<float>
y : IReadOnlyList<float>
Returns: DoubleMatrix

DoubleMatrix.Multiply(a, b)

Full Usage: DoubleMatrix.Multiply(a, b)

Parameters:
    a : float - double to act as left operator.
    b : DoubleMatrix - DoubleMatrix to act as right operator.

Returns: DoubleMatrix DoubleMatrix with results.

Multiply a DoubleMatrix's elements with a double.

a : float

double to act as left operator.

b : DoubleMatrix

DoubleMatrix to act as right operator.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.Multiply(a, b)

Full Usage: DoubleMatrix.Multiply(a, b)

Parameters:
    a : DoubleMatrix - DoubleMatrix whose elements to multiply.
    b : float - double to multiply with.

Returns: DoubleMatrix DoubleMatrix with results

Multiply a DoubleMatrix's elements with a double.

a : DoubleMatrix

DoubleMatrix whose elements to multiply.

b : float

double to multiply with.

Returns: DoubleMatrix

DoubleMatrix with results

ArgumentNullException matrix is null.

DoubleMatrix.Multiply(a, b)

Full Usage: DoubleMatrix.Multiply(a, b)

Parameters:
Returns: DoubleVector DoubleMatrix with results

Multiply a DoubleMatrix with a DoubleVector.

a : DoubleMatrix

DoubleMatrix to act as left operator.

b : DoubleVector

DoubleVector to act as right operator.

Returns: DoubleVector

DoubleMatrix with results

ArgumentException dimensions are not conformable.
ArgumentNullException either matrix or vector is null.

DoubleMatrix.Multiply(a, b)

Full Usage: DoubleMatrix.Multiply(a, b)

Parameters:
Returns: DoubleMatrix DoubleMatrix with results

Multiply a DoubleMatrix with a DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to act as left operator.

b : DoubleMatrix

DoubleMatrix to act as right operator.

Returns: DoubleMatrix

DoubleMatrix with results

ArgumentException dimensions are not conformable.
ArgumentNullException either matrix is null.

DoubleMatrix.Negate(a)

Full Usage: DoubleMatrix.Negate(a)

Parameters:
Returns: DoubleMatrix DoubleMatrix with values to negate.

Negate the values in DoubleMatrix.

a : DoubleMatrix
Returns: DoubleMatrix

DoubleMatrix with values to negate.

ArgumentNullException matrix is null.

DoubleMatrix.Random(rows, columns)

Full Usage: DoubleMatrix.Random(rows, columns)

Parameters:
    rows : int - Numer of rows of the matrix to create.
    columns : int - Number of columns of the matrix to create.

Returns: DoubleMatrix Matrix with elements set to random values between 0 and 1

Creates a matrix with elements set to random values between 0 and 1.

rows : int

Numer of rows of the matrix to create.

columns : int

Number of columns of the matrix to create.

Returns: DoubleMatrix

Matrix with elements set to random values between 0 and 1

DoubleMatrix.Subtract(a, b)

Full Usage: DoubleMatrix.Subtract(a, b)

Parameters:
Returns: DoubleMatrix DoubleMatrix with results.

Subtract a DoubleMatrix from another DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to subtract from.

b : DoubleMatrix

DoubleMatrix to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException either matrix is null.

DoubleMatrix.Subtract(a, b)

Full Usage: DoubleMatrix.Subtract(a, b)

Parameters:
    a : float - double to subtract from.
    b : DoubleMatrix - DoubleMatrix to subtract.

Returns: DoubleMatrix DoubleMatrix with results.

Subtract a DoubleMatrix from a double.

a : float

double to subtract from.

b : DoubleMatrix

DoubleMatrix to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.Subtract(a, b)

Full Usage: DoubleMatrix.Subtract(a, b)

Parameters:
    a : DoubleMatrix - DoubleMatrix to subtract from.
    b : float - double to subtract.

Returns: DoubleMatrix DoubleMatrix with results.

Subtract a double from a DoubleMatrix.

a : DoubleMatrix

DoubleMatrix to subtract from.

b : float

double to subtract.

Returns: DoubleMatrix

DoubleMatrix with results.

ArgumentNullException matrix is null.

DoubleMatrix.ToDoubleMatrix(source)

Full Usage: DoubleMatrix.ToDoubleMatrix(source)

Parameters:
    source : FloatMatrix - FloatMatrix to make a deep copy conversion from.

Returns: DoubleMatrix

Implicit conversion from FloatMatrix matrix.

source : FloatMatrix

FloatMatrix to make a deep copy conversion from.

Returns: DoubleMatrix

DoubleMatrix.ToDoubleMatrix(source)

Full Usage: DoubleMatrix.ToDoubleMatrix(source)

Parameters:
    source : float[,]

Returns: DoubleMatrix

source : float[,]
Returns: DoubleMatrix

DoubleMatrix.ToDoubleMatrix(source)

Full Usage: DoubleMatrix.ToDoubleMatrix(source)

Parameters:
    source : float32[,]

Returns: DoubleMatrix

source : float32[,]
Returns: DoubleMatrix

DoubleMatrix.ToLinearArray(matrix)

Full Usage: DoubleMatrix.ToLinearArray(matrix)

Parameters:
    matrix : IROMatrix<float> - The matrix to convert to an array.

Returns: float[] Linear array of complex.

This creates a linear array for use with unmanaged routines.

matrix : IROMatrix<float>

The matrix to convert to an array.

Returns: float[]

Linear array of complex.

DoubleMatrix.ToLinearArray(matrix)

Full Usage: DoubleMatrix.ToLinearArray(matrix)

Parameters:
    matrix : IROMatrix<float32> - The matrix to convert to an array.

Returns: float[] Linear array of complex.

This creates a linear array for use with unmanaged routines.

matrix : IROMatrix<float32>

The matrix to convert to an array.

Returns: float[]

Linear array of complex.

DoubleMatrix.ToLinearArray(source)

Full Usage: DoubleMatrix.ToLinearArray(source)

Parameters:
    source : IReadOnlyList<float> - The vector to convert to an array.

Returns: float[] Linear array of complex.

This creates a linear array for use with unmanaged routines.

source : IReadOnlyList<float>

The vector to convert to an array.

Returns: float[]

Linear array of complex.

op_Implicitsource

Full Usage: op_Implicitsource

Parameters:
Returns: DoubleMatrix

source : FloatMatrix
Returns: DoubleMatrix

op_Implicitsource

Full Usage: op_Implicitsource

Parameters:
Returns: MatrixWrapperStructForLeftSpineJaggedArray<float>

source : DoubleMatrix
Returns: MatrixWrapperStructForLeftSpineJaggedArray<float>

op_Implicitsource

Full Usage: op_Implicitsource

Parameters:
    source : float[,]

Returns: DoubleMatrix

source : float[,]
Returns: DoubleMatrix

op_Implicitsource

Full Usage: op_Implicitsource

Parameters:
    source : float32[,]

Returns: DoubleMatrix

source : float32[,]
Returns: DoubleMatrix