[Home] Type Microsoft.FSharp.Math.Types.Matrix


The type of matrices. The arithmetic operations on the element type are determined by inspection on the element type itself

Full Type Signature

type Matrix <'a> = {opsM: 'a opsData;
                    arrM: 'a [,];}
                   with
                     interface IFormattable
                     interface IStructuralHash
                     interface IComparable
                     member Item : int * int -> 'a with set
                     static member ( ~+ ) : Matrix<'a> -> Matrix<'a>
                     static member ( ~- ) : Matrix<'a> -> Matrix<'a>
                     static member ( -= ) : Matrix<'a> * Matrix<'a> -> unit
                     static member ( - ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
                     static member ( *$ ) : Matrix<'a> * 'a -> Matrix<'a>
                     static member ( * ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
                     static member ( .*= ) : Matrix<'a> * Matrix<'a> -> unit
                     static member ( .* ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
                     static member ( $* ) : 'a * Matrix<'a> -> Matrix<'a>
                     static member ( += ) : Matrix<'a> * Matrix<'a> -> unit
                     static member ( + ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
                     member Transpose : Matrix<'a> with get
                     member NumRows : int with get
                     member NumCols : int with get
                     member Item : int * int -> 'a with get
                     member ElementOps : INumeric<'a> with get
                     member Dimensions : int * int with get
                   end

Instance Members

MemberDescription
member Dimensions : int * int with get
The number of (rows,columns) in the matrix
member ElementOps : INumeric<'a> with get
Retrieve the dictionary of numeric operations associated with the element type of this matrix. Accessing the property may raise an NotSupportedException if the element type doesn't support any numeric operations. The object returned may support additional numeric operations such as IFractional: this can be determined by a dynamic type test against the object returned.
member Item : int * int -> 'a with get
Get the item at the given position in the matrix
member NumCols : int with get
The number of columns in the matrix
member NumRows : int with get
The number of rows in the matrix
member Transpose : Matrix<'a> with get
Get the transpose of the matrix
member Item : int * int -> 'a with set
Get the item at the given position in the matrix

Static Members

MemberDescription
member ( + ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
Point-wise addition of two matrices. An InvalidArgument exception will be raised if the dimensions do not match.
member ( += ) : Matrix<'a> * Matrix<'a> -> unit
Inplace matrix addition. An InvalidArgument exception will be raised if the dimensions do not match.
member ( $* ) : 'a * Matrix<'a> -> Matrix<'a>
Multiply each element of a matrix by the given scalar value
member ( .* ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
Pointwise matrix multiplication. An InvalidArgument exception will be raised if the dimensions do not match.
member ( .*= ) : Matrix<'a> * Matrix<'a> -> unit
Inplace pointwise matrix multiplication. An InvalidArgument exception will be raised if the dimensions do not match.
member ( * ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
Matrix multiplication. An InvalidArgument exception will be raised if the dimensions do not match.
member ( *$ ) : Matrix<'a> * 'a -> Matrix<'a>
Multiply each element of a matrix by the given scalar value
member ( - ) : Matrix<'a> * Matrix<'a> -> Matrix<'a>
Point-wise subtraction of two matrices. An InvalidArgument exception will be raised if the dimensions do not match.
member ( -= ) : Matrix<'a> * Matrix<'a> -> unit
Inplace matrix subtraction. An InvalidArgument exception will be raised if the dimensions do not match.
member ( ~- ) : Matrix<'a> -> Matrix<'a>
Matrix negation.
member ( ~+ ) : Matrix<'a> -> Matrix<'a>
A nop.

See Also

Microsoft.FSharp.Math.Types


Documentation for assembly fslib, version 1.1.10.1, generated using F# version 1.1.10.1