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.VectorBase Class Reference

Implements functionality shared between row and column vectors. More...

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

Public Member Functions

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...
 

Properties

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...
 

Private Member Functions

IEnumerator IEnumerable. GetEnumerator ()
 
void ICollection< double >. Add (double item)
 
void ICollection< double >. Clear ()
 
bool ICollection< double >. Contains (double item)
 
void ICollection< double >. CopyTo (double[] array, int arrayIndex)
 
bool ICollection< double >. Remove (double item)
 
int IList< double >. IndexOf (double item)
 
void IList< double >. Insert (int index, double item)
 
void IList< double >. RemoveAt (int index)
 

Private Attributes

int stride
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from Meta.Numerics.Matrices.AnyRectangularMatrix
 AnyRectangularMatrix ()
 
- Protected Member Functions inherited from Meta.Numerics.Matrices.AnyMatrix< T >
 AnyMatrix ()
 

Detailed Description

Implements functionality shared between row and column vectors.

See also
RowVector, ColumnVector

Member Function Documentation

virtual double Meta.Numerics.Matrices.VectorBase.Norm ( )
inlinevirtual

Computes the magnitude of the vector.

Returns
The Euclidean norm of the vector.

Referenced by Test.VectorTest.ExtendedVectorNorm(), Meta.Numerics.Analysis.FunctionMath.FindZero(), and Test.VectorTest.VectorNorm().

virtual new double [] Meta.Numerics.Matrices.VectorBase.ToArray ( )
inlinevirtual

Returns the vector elements in an independent array.

Returns
An array containing the vector element values.

Reimplemented from Meta.Numerics.Matrices.AnyMatrix< T >.

Referenced by Meta.Numerics.Analysis.FunctionMath.FindZero().

IEnumerator<double> Meta.Numerics.Matrices.VectorBase.GetEnumerator ( )
inline

Gets an enumerator of the vector components.

Returns
An enumerator of the vector components.
IEnumerator IEnumerable. Meta.Numerics.Matrices.VectorBase.GetEnumerator ( )
inlineprivate
void ICollection<double>. Meta.Numerics.Matrices.VectorBase.Add ( double  item)
inlineprivate
void ICollection<double>. Meta.Numerics.Matrices.VectorBase.Clear ( )
inlineprivate
bool ICollection<double>. Meta.Numerics.Matrices.VectorBase.Contains ( double  item)
inlineprivate
void ICollection<double>. Meta.Numerics.Matrices.VectorBase.CopyTo ( double[]  array,
int  arrayIndex 
)
inlineprivate
bool ICollection<double>. Meta.Numerics.Matrices.VectorBase.Remove ( double  item)
inlineprivate
int IList<double>. Meta.Numerics.Matrices.VectorBase.IndexOf ( double  item)
inlineprivate
void IList<double>. Meta.Numerics.Matrices.VectorBase.Insert ( int  index,
double  item 
)
inlineprivate
void IList<double>. Meta.Numerics.Matrices.VectorBase.RemoveAt ( int  index)
inlineprivate

Member Data Documentation

int Meta.Numerics.Matrices.VectorBase.stride
private

Property Documentation

virtual double Meta.Numerics.Matrices.VectorBase.this[int index]
getset

Gets or sets the specified vector component.

Parameters
indexThe (zero-based) component index.
Returns
The value of the specified vector component.
int ICollection<double>. Meta.Numerics.Matrices.VectorBase.Count
getprivate
bool ICollection<double>. Meta.Numerics.Matrices.VectorBase.IsReadOnly
getprivate

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