IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Meta.Numerics.Matrices.ColumnVector Class Reference

A column vector of real numbers. More...

+ Inheritance diagram for Meta.Numerics.Matrices.ColumnVector:
+ Collaboration diagram for Meta.Numerics.Matrices.ColumnVector:

Public Member Functions

 ColumnVector (int dimension)
 Initializes a new column vector with the given dimension. More...
 
 ColumnVector (IList< double > list)
 Initializes a new column vector from the given component list. More...
 
 ColumnVector (params double[] list)
 Initializes a new column vector with the given components. More...
 
RowVector Transpose ()
 Returns the transpose of the column vector. More...
 
ColumnVector Copy ()
 Returns a copy of the column vector. More...
 
- Public Member Functions inherited from Meta.Numerics.Matrices.VectorBase
virtual double Norm ()
 Computes the magnitude of the vector. More...
 
virtual new double[] ToArray ()
 Returns the vector elements in an independent array. More...
 
IEnumerator< double > GetEnumerator ()
 Gets an enumerator of the vector components. More...
 
- Public Member Functions inherited from Meta.Numerics.Matrices.AnyRectangularMatrix
virtual double OneNorm ()
 Computes the 1-norm of the matrix. More...
 
virtual double InfinityNorm ()
 Computes the &#x221E;-norm of the matrix. More...
 
virtual double FrobeniusNorm ()
 Computes the Frobenius-norm of the matrix. More...
 
virtual ColumnVector Column (int c)
 Gets a copy of the specified column. More...
 
virtual RowVector Row (int r)
 Gets a copy of the specified row. More...
 
virtual SymmetricMatrix MultiplySelfByTranspose ()
 Computes the product of the matrix and its transpose. More...
 
virtual SymmetricMatrix MultiplyTransposeBySelf ()
 Computes the product of the matrix's transpose and itself. More...
 
bool Equals (AnyRectangularMatrix other)
 Determines whether the given matrix equals the current matrix. More...
 
override bool Equals (object obj)
 Determines whether the given object is an equal matrix. More...
 
override int GetHashCode ()
 Not a valid operation. More...
 
- Public Member Functions inherited from Meta.Numerics.Matrices.AnyMatrix< T >
virtual void Fill (Func< int, int, T > f)
 Sets all matrix entries according to a supplied fill function. More...
 

Static Public Member Functions

static ColumnVector operator+ (ColumnVector v1, ColumnVector v2)
 Computes the sum of two column vectors. More...
 
static ColumnVector operator- (ColumnVector v1, ColumnVector v2)
 Computes the difference of two column vectors. More...
 
static ColumnVector operator* (double alpha, ColumnVector v)
 Multiplies a column vector by a real, scalar constant. More...
 
static ColumnVector operator/ (ColumnVector v, double alpha)
 Divides a column vector by a real, scalar constant. More...
 
static ColumnVector operator- (ColumnVector v)
 Negates a column vector. More...
 
- Static Public Member Functions inherited from Meta.Numerics.Matrices.AnyRectangularMatrix
static RectangularMatrix operator+ (AnyRectangularMatrix A, AnyRectangularMatrix B)
 Adds any two real, rectangular matrices. More...
 
static RectangularMatrix operator- (AnyRectangularMatrix A, AnyRectangularMatrix B)
 Subtracts any two real, rectangular matrices. More...
 
static RectangularMatrix operator* (AnyRectangularMatrix A, AnyRectangularMatrix B)
 Multiplies any two real, rectangular matrices. More...
 
static RectangularMatrix operator* (double alpha, AnyRectangularMatrix A)
 Multiplies any real, rectangular matrix by a real constant. More...
 
static ColumnVector operator* (AnyRectangularMatrix A, ColumnVector v)
 Multiplies any real, rectangular matrix with a real column vector. More...
 
static bool operator== (AnyRectangularMatrix A, AnyRectangularMatrix B)
 Determines whether two matrices are equal. More...
 
static bool operator!= (AnyRectangularMatrix A, AnyRectangularMatrix B)
 Determines whether two matrices are not equal. More...
 

Properties

override int RowCount [get]
 
override int ColumnCount [get]
 
override double this[int r, int c] [get, set]
 
- Properties inherited from Meta.Numerics.Matrices.VectorBase
virtual double this[int index] [get, set]
 Gets or sets the specified vector component. More...
 
virtual int Dimension [get]
 Gets the dimension of the vector. More...
 
int ICollection< double >. Count [get]
 
bool ICollection< double >. IsReadOnly [get]
 
- Properties inherited from Meta.Numerics.Matrices.AnyMatrix< T >
abstract int RowCount [get]
 Gets the number of matrix rows. More...
 
abstract int ColumnCount [get]
 Gets the number of matrix columns. More...
 
abstract T this[int r, int c] [get, set]
 Gets or sets the value of a matrix entry. More...
 
bool IsReadOnly [get, set]
 Gets a flag indicating whether the matrix is read-only. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Meta.Numerics.Matrices.AnyRectangularMatrix
 AnyRectangularMatrix ()
 
- Protected Member Functions inherited from Meta.Numerics.Matrices.AnyMatrix< T >
 AnyMatrix ()
 

Detailed Description

A column vector of real numbers.

An N-dimensional column vector is an N X 1 dimensional matrix.

Constructor & Destructor Documentation

Meta.Numerics.Matrices.ColumnVector.ColumnVector ( int  dimension)
inline

Initializes a new column vector with the given dimension.

Parameters
dimensionThe dimension of the vector, which must be positive.
Meta.Numerics.Matrices.ColumnVector.ColumnVector ( IList< double >  list)
inline

Initializes a new column vector from the given component list.

Parameters
listA list of vector components.
Meta.Numerics.Matrices.ColumnVector.ColumnVector ( params double[]  list)
inline

Initializes a new column vector with the given components.

Parameters
listA list of vector components.

Member Function Documentation

ColumnVector Meta.Numerics.Matrices.ColumnVector.Copy ( )
inline

Returns a copy of the column vector.

Returns
An independent copy of the column vector.

References Meta.Numerics.Matrices.ColumnVector.Copy().

Referenced by Test.VectorTest.ColumnVectorCopy(), Meta.Numerics.Matrices.ColumnVector.Copy(), and Meta.Numerics.Matrices.RowVector.Transpose().

static ColumnVector Meta.Numerics.Matrices.ColumnVector.operator+ ( ColumnVector  v1,
ColumnVector  v2 
)
inlinestatic

Computes the sum of two column vectors.

Parameters
v1The first column vector.
v2The second column vector.
Returns
The sum v1 + v2 .
static ColumnVector Meta.Numerics.Matrices.ColumnVector.operator- ( ColumnVector  v1,
ColumnVector  v2 
)
inlinestatic

Computes the difference of two column vectors.

Parameters
v1The first column vector.
v2The second column vector.
Returns
The difference v1 - v2 .
static ColumnVector Meta.Numerics.Matrices.ColumnVector.operator* ( double  alpha,
ColumnVector  v 
)
inlinestatic

Multiplies a column vector by a real, scalar constant.

Parameters
alphaThe real, scalar constant.
vThe column vector.
Returns
The product.
static ColumnVector Meta.Numerics.Matrices.ColumnVector.operator/ ( ColumnVector  v,
double  alpha 
)
inlinestatic

Divides a column vector by a real, scalar constant.

Parameters
alphaThe real, scalar constant.
vThe column vector.
Returns
The product.
static ColumnVector Meta.Numerics.Matrices.ColumnVector.operator- ( ColumnVector  v)
inlinestatic

Negates a column vector.

Parameters
vThe column vector.
Returns
-v

Property Documentation

override int Meta.Numerics.Matrices.ColumnVector.RowCount
get

override int Meta.Numerics.Matrices.ColumnVector.ColumnCount
get

override double Meta.Numerics.Matrices.ColumnVector.this[int r, int c]
getset


The documentation for this class was generated from the following file: