mimo Namespace Reference

Compounds

class Multiply

Base class for a general Multiply block. More...

class MultiplyTM

Matrix Multiply implementation block. More...

class SquareTM

Calculate the Product of a Matrix with itself. More...

class MultiplyInvTM

Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...

class CalcCapacity

class CalcMax

class InvertTM

Inversion of the input samples when sample are a matrix. More...

class ChannelEstim

class EstimSingleCarrier

class EstimOFDM

class Equalizer

class EqualizerZF

ZF Equalizer, i.e. Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...

class EqualizerMMSE

MMSE Equalizer, i.e. Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...

class EqualizerMRC

Maximum Ratio-Combining Equalizer,. More...

class EqualizerMRCSwitch

Maximum Ratio-Combining Equalizer,. More...

class FadingMIMOChannel

MIMOChannel for statistical fading model. More...

class CmplFadingMIMOChannel

class MSequenceBase

Base class for implementing access to a sequence. More...

class MSequence

Base class for implementing access to a sequence. More...

class MSequenceStorage

Implementation of a sequence. More...

class MSequenceAccess

Implementation of a shallow copy of a sequence. More...

class MSeqAttrT

class MFreqSeqAttrT

class MTimeSeqAttrT

class VSeqAttrT

class VTimeSeqAttrT

class MaxEntropyChannel

class MIMOChannel

class PerfectMIMOChannel

class AWGNMIMOChannel

class AntennaArray

Abstract base class that describes the geometry of the antenna array. More...

class UniformLinearLambdaHalf

class UniformCircularLambdaHalf

class NonUniform

class Decoder

Abstract base class for a MIMO symbol decoder. More...

class SpatialMuxDecZF

class SpatialMuxDecMMSE

class STBCAlamoutiDec

class SVDDec

class Encoder

Abstract base class for a MIMO symbol encoder. More...

class SpatialMuxEnc

class STBCAlamoutiEnc

class SVDEnc

class LsdDecoder

class LsdEncoder

class Multiplexer

Base class for a general Multiplexer/Demultiplexer. More...

class MultiplexerT

Multiplexer. More...

class MultiplexerT< CMatrixSeq >

class ToVector

class FromVector

class FromDiag

class FromMat

class Vectorize

class PathParam

class WSSUSChannel

class WSSUSChannelJakesUniform

class WSSUSChannelExpDelay

class WSSUSChannelBU

class WSSUSChannelHT

class WSSUSChannelScattering

class WSSUSChannelFreqTimeCorr

class WSSUSChannelRA

WSSUS channel for a rural area (COST). More...

class WSSUSChannelTU

class FileMimoChannel

Complex Matrix operations

int real_size (const CMatrix &, int complex_size)

const Complex & c_assign (CMatrix &A, int i, int j, const Complex &c)

Complex c_access (const CMatrix &A, int i, int j)

std::ostream & c_print (std::ostream &s, const CMatrix &G)

int c_size (const CMatrix &A, int dim)

CMatrix c_eye (int i)

CMatrix c_zeros (int i, int j)

CMatrix c_ones (int i, int j)

const Complex & c_add_s (CMatrix &A, int i, int j, const Complex &c)

simth::Complex c_det (const CMatrix &A)

Real-valued Matrix operations

Matrix eye (int i)

Matrix zeros (int i, int j)

Matrix ones (int i, int j)

double det (const Matrix &A)

Pseudo-complex Vector operations

const Complex & c_assign (CVector &A, int i, const Complex &c)

Complex c_access (const CVector &A, int i)

std::ostream & c_print (std::ostream &s, const CVector &G)

int c_size (const CVector &A)

const Complex & c_add_s (CVector &a, int i, const Complex &c)

CVector c_ones (int i)

CVector c_zeros (int i)

Vector zeros (int i)

Blas routines

All of these are originally defined inside the Blas++ headers. But there, they are (of course) only defined for real-valued vectors. Here we add versions that can deal with our pseudo-complex vectors and matrices and also Complex numbers.

void Blas_Add_Mult (CVector &dy, const Complex &c, const CVector &dx)

void Blas_Mult (CVector &dy, const Complex &c, const CVector &dx)

void Blas_Scale (const Complex &c, CVector &dx)

Complex Blas_Dot_Prod (const CVector &dx, const CVector &dy)

void Blas_R1_Update (CMatrix &A, const CVector &dx, const CVector &dy, const Complex &alpha)

double Blas_NormF (const CMatrix &A)

void Mat_Add_Norm (Matrix &A, const CMatrix &B)

double Mat_Norm1 (const Matrix &A)

Typedefs

typedef LaComplex Complex

We need a special complex type here. It has the necessary conversion operators to everything else.

typedef LaGenMatDouble Matrix

Matrix of real double values.

typedef LaVectorDouble Vector

Vector of real double values.

typedef LaGenMatComplex CMatrix

Matrix of complex double values.

typedef LaVectorComplex CVector

Vector of complex double values.

typedef MSequence< CMatrix,
MSeqAttrT< CMatrix > > CMatrixSeq

typedef MSequence< CMatrix,
MFreqSeqAttrT< CMatrix > > MatrixFreqSignal

typedef MSequence< CVector,
VSeqAttrT< CVector > > CVectorSeq

typedef MSequence< CVector,
VTimeSeqAttrT< CVector > > VectorTimeSignal

typedef MSequence< CMatrix,
MTimeSeqAttrT< CMatrix > > MatrixTimeSignal

Functions

std::ostream & operator<< (std::ostream &os, const MIMOChannel &cha)

std::ostream & operator<< (std::ostream &os, const Decoder &enc)

std::ostream & operator<< (std::ostream &os, const Encoder &enc)

Variables

const double DELAY_THRESHOLD = 0.001

Detailed Description

Namespace for mimo code. Notably, the matrix class is implemented here. In order for the type name 'Matrix' not to collide with someone else, this namespace was created.

The matrix and vector types appear for complex and real (double) values.

Historical note: Until 2004-01-14, we used a 'pseudo-complex matrix' which in fact was a real-valued matrix of double the size. This was the reason why we invented the c_access and c_assign functions.

Typedef Documentation

typedef LaComplex mimo::Complex

We need a special complex type here. It has the necessary conversion operators to everything else.

typedef LaGenMatDouble mimo::Matrix

Matrix of real double values.

typedef LaVectorDouble mimo::Vector

Vector of real double values.

typedef LaGenMatComplex mimo::CMatrix

Matrix of complex double values.
This is a matrix of complex (double) values. The row and column indices for accessing elements start from zero, different from what you would write in mathematical notation. This means you have

$A_{n\times m} = \left(\begin{array}{ccc} a_{11} & & a_{1m} \\ & \ddots & \\ a_{n1} & & a_{nm} \end{array}\right)$

but for accessing the element $a_{11}$ you have to write A(0,0).
More (but sometimes outdated) documentation can be found in the Lapackpp header files.
Historical note: Until 2004-01-14, we used a 'pseudo-complex matrix' which in fact was a real-valued matrix of double the size. This was the reason why we invented the c_access and c_assign functions.

typedef LaVectorComplex mimo::CVector

Vector of complex double values.
This is a vector of complex (double) values. The element indices start from zero, different from what you would write in mathematical notation. This means you have

$w_{n} = \left(\begin{array}{c} w_1 \\ \vdots \\ w_n \end{array}\right)$

but for accessing the element $w_1$ you have to write w(0).
More (but sometimes outdated) documentation can be found in the Lapackpp header files.
Historical note: Until 2004-01-14, we used a 'pseudo-complex vector' which in fact was a real-valued vector of double the size. This was the reason why we invented the c_access and c_assign functions.

typedef MSequence<CMatrix, MSeqAttrT<CMatrix> > mimo::CMatrixSeq

Sequence of matrices of scalar complex doubles ('complex values').

typedef MSequence<CMatrix, MFreqSeqAttrT<CMatrix> > mimo::MatrixFreqSignal

Frequency sequence with matrices of scalar complex doubles ('complex values').

typedef MSequence<CVector, VSeqAttrT<CVector> > mimo::CVectorSeq

Sequence of vectors of scalar complex doubles ('complex values').

typedef MSequence<CVector, VTimeSeqAttrT<CVector> > mimo::VectorTimeSignal

Time sequence with vectors of scalar complex doubles ('complex values').

typedef MSequence<CMatrix, MTimeSeqAttrT<CMatrix> > mimo::MatrixTimeSignal

Time sequence with matrices of scalar complex doubles ('complex values').

Function Documentation

int real_size ( const CMatrix & ,

int complex_size

) [inline]

DEPRECATED. Returns the actual storage size for any given complex_size of the pseudo-complex Matrix type. This function has no effect any longer -- it simply returns its argument.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

complex_size A size (i.e. any one of the matrix dimensions) that is used for the pseudo-complex data type.

Returns:
The actual (i.e. any one of the matrix dimensions) size of the underlying real matrix.

const Complex& c_assign ( CMatrix & A,

int i,

int j,

const Complex & c

) [inline]

Assigns a complex value to an element of the given pseudo-complex matrix A.
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

Parameters:

A The pseudo-complex matrix where the element should be manipulated.

i Row index, starting at zero

j Column index, starting at zero

c The complex number that should be written into the pseudo-complex matrix.

Returns:
A reference to the complex number that was just written into the matrix.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

Complex c_access ( const CMatrix & A,

int i,

int j

) [inline]

Returns a complex element of the pseudo-complex matrix A.
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

A The pseudo-complex matrix from which the element should be returned.

i Row index, starting at zero

j Column index, starting at zero

Returns:
The complex value at the given position in the matrix.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

std::ostream& c_print ( std::ostream & s,

const CMatrix & G

)

DEPRECATED. Print the pseudo-complex matrices.

int c_size ( const CMatrix & A,

int dim

) [inline]

DEPRECATED. Returns the pseudo-complex size of the pseudo-complex matrix.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

A The matrix of which the size should be returned.

dim The dimension whose size should be returned. In mathematical notation dim=0 are the rows and dim=1 are the columns.

Returns:
The size of the specified dimension. The indices for row and column run from zero to size-1.

CMatrix c_eye ( int i )

DEPRECATED. Returns a newly created identity matrix, with pseudo-complex size i x i.

CMatrix c_zeros ( int i,

int j

)

Returns a newly created matrix of zeros, with pseudo-complex size i x j.

CMatrix c_ones ( int i,

int j

)

Returns a newly created matrix of ones, with pseudo-complex size i x j.

const Complex& c_add_s ( CMatrix & A,

int i,

int j,

const Complex & c

) [inline]

Add a complex scalar to a matrix component.
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

A The pseudo-complex matrix where the element should be manipulated.

i Row index, starting at zero

j Column index, starting at zero

c The complex number that should be added to the specified element of the pseudo-complex matrix.

Returns:
A reference to the complex number that was just added to the matrix element.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

simth::Complex c_det ( const CMatrix & A )

Returns the complex determinant of the complex square matrix A. This algorithm calculated the LU factorization and multiplies its diagonal.

Matrix eye ( int i )

Returns a newly created identity matrix (square), with size i x i

Matrix zeros ( int i,

int j

)

Returns a newly created matrix of zeros, with size i x j.

Matrix ones ( int i,

int j

)

Returns a newly created matrix of ones, with size i x j.

double det ( const Matrix & A )

Returns the determinant of the square matrix A. This algorithm calculated the LU factorization and multiplies its diagonal.

const Complex& c_assign ( CVector & A,

int i,

const Complex & c

) [inline]

Assigns a complex value to an element of the given pseudo-complex vector A
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

A The pseudo-complex vector where the element should be manipulated.

i Position index, starting at zero

c The complex number that should be written into the pseudo-complex vector.

Returns:
A reference to the complex number that was just written into the vector.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

Complex c_access ( const CVector & A,

int i

) [inline]

Returns a complex element of the pseudo-complex vector A.
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

A The pseudo-complex vector from which the element should be returned.

i Position index, starting at zero

Returns:
The complex value at the given position in the vector.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

std::ostream& c_print ( std::ostream & s,

const CVector & G

)

DEPRECATED. Print the pseudo-complex vector.

int c_size ( const CVector & A ) [inline]

DEPRECATED. Returns the pseudo-complex size of the pseudo-complex vector.

const Complex& c_add_s ( CVector & a,

int i,

const Complex & c

) [inline]

Add a complex scalar to a vector component.
Even though this function is not strictly necessary nowadays, it might still be useful in order to have the correct type conversions taking place.
Historical note: This function used to be necessary until 2004-01-14, when 'pseudo-complex matrices' were used instead of native complex matrices. After that date, this project uses natively complex matrices and this function now is no longer necessary.

Parameters:

a The pseudo-complex vector where the element should be manipulated.

i Position index, starting at zero

c The complex number that should be added to the specified element of the pseudo-complex vector.

Returns:
A reference to the complex number that was just added into the vector.

Note:
If DEBUG is defined, i.e. you configured this package with --enable-debug, then every access is range-checked and any out of range access will result in a failed assertion in this file. However, if DEBUG is switched off, then any out of range access will probably result in very strange Lapack/Blas segmentation faults.

CVector c_ones ( int i )

DEPRECATED. Returns a newly created vector of ones, with pseudo-complex size i x j.

CVector c_zeros ( int i )

DEPRECATED. Returns a newly created vector of zeros, with pseudo-complex size i x j.

Vector zeros ( int i )

Returns a newly created vector of zeros, with size i x j.

void Blas_Add_Mult ( CVector & dy,

const Complex & c,

const CVector & dx

) [inline]

Combined vector scaling and addition: dy = dy + c * dx

void Blas_Mult ( CVector & dy,

const Complex & c,

const CVector & dx

) [inline]

Combined vector scaling: dy = c * dx

void Blas_Scale ( const Complex & c,

CVector & dx

) [inline]

Vector scaling: dx = c * dx

Complex Blas_Dot_Prod ( const CVector & dx,

const CVector & dy

) [inline]

Returns the dot product of two vectors x and y, which is x'*y. Note: For complex vectors this is no longer commutative, but rather complex conjugate commutative.

void Blas_R1_Update ( CMatrix & A,

const CVector & dx,

const CVector & dy,

const Complex & alpha

) [inline]

Perform the rank 1 operation A := alpha*dx*dy' + A Note: the vector dy' is the _conjugate_ transposed of dy.

double Blas_NormF ( const CMatrix & A )

Returns the squared (!) Frobenius-Norm of matrix A: sum |h_ij|^2 over all i,j

void Mat_Add_Norm ( Matrix & A,

const CMatrix & B

)

Calculate the std::norm of each element of B and add it to the respective element of the matrix A. B is a *complex* matrix, whereas A is a real-valued (nonnegative) matrix.

double Mat_Norm1 ( const Matrix & A )

Calculate the sum over all matrix elements of A.

std::ostream& operator<< ( std::ostream & os,

const MIMOChannel & cha

)

std::ostream& operator<< ( std::ostream & os,

const Decoder & enc

)

std::ostream& operator<< ( std::ostream & os,

const Encoder & enc

)

Variable Documentation

const double mimo::DELAY_THRESHOLD = 0.001

Generated on Fri Jul 23 16:27:48 2004 for mimolib by

1.3.2


Compounds
class	Multiply
	Base class for a general Multiply block. More...
class	MultiplyTM
	Matrix Multiply implementation block. More...
class	SquareTM
	Calculate the Product of a Matrix with itself. More...
class	MultiplyInvTM
	Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...
class	CalcCapacity
class	CalcMax
class	InvertTM
	Inversion of the input samples when sample are a matrix. More...
class	ChannelEstim
class	EstimSingleCarrier
class	EstimOFDM
class	Equalizer
class	EqualizerZF
	ZF Equalizer, i.e. Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...
class	EqualizerMMSE
	MMSE Equalizer, i.e. Matrix inversion and multiplication block, i.e. the solution of a linear equation system. More...
class	EqualizerMRC
	Maximum Ratio-Combining Equalizer,. More...
class	EqualizerMRCSwitch
	Maximum Ratio-Combining Equalizer,. More...
class	FadingMIMOChannel
	MIMOChannel for statistical fading model. More...
class	CmplFadingMIMOChannel
class	MSequenceBase
	Base class for implementing access to a sequence. More...
class	MSequence
	Base class for implementing access to a sequence. More...
class	MSequenceStorage
	Implementation of a sequence. More...
class	MSequenceAccess
	Implementation of a shallow copy of a sequence. More...
class	MSeqAttrT
class	MFreqSeqAttrT
class	MTimeSeqAttrT
class	VSeqAttrT
class	VTimeSeqAttrT
class	MaxEntropyChannel
class	MIMOChannel
class	PerfectMIMOChannel
class	AWGNMIMOChannel
class	AntennaArray
	Abstract base class that describes the geometry of the antenna array. More...
class	UniformLinearLambdaHalf
class	UniformCircularLambdaHalf
class	NonUniform
class	Decoder
	Abstract base class for a MIMO symbol decoder. More...
class	SpatialMuxDecZF
class	SpatialMuxDecMMSE
class	STBCAlamoutiDec
class	SVDDec
class	Encoder
	Abstract base class for a MIMO symbol encoder. More...
class	SpatialMuxEnc
class	STBCAlamoutiEnc
class	SVDEnc
class	LsdDecoder
class	LsdEncoder
class	Multiplexer
	Base class for a general Multiplexer/Demultiplexer. More...
class	MultiplexerT
	Multiplexer. More...
class	MultiplexerT< CMatrixSeq >
class	ToVector
class	FromVector
class	FromDiag
class	FromMat
class	Vectorize
class	PathParam
class	WSSUSChannel
class	WSSUSChannelJakesUniform
class	WSSUSChannelExpDelay
class	WSSUSChannelBU
class	WSSUSChannelHT
class	WSSUSChannelScattering
class	WSSUSChannelFreqTimeCorr
class	WSSUSChannelRA
	WSSUS channel for a rural area (COST). More...
class	WSSUSChannelTU
class	FileMimoChannel
Complex Matrix operations
int	real_size (const CMatrix &, int complex_size)
const Complex &	c_assign (CMatrix &A, int i, int j, const Complex &c)
Complex	c_access (const CMatrix &A, int i, int j)
std::ostream &	c_print (std::ostream &s, const CMatrix &G)
int	c_size (const CMatrix &A, int dim)
CMatrix	c_eye (int i)
CMatrix	c_zeros (int i, int j)
CMatrix	c_ones (int i, int j)
const Complex &	c_add_s (CMatrix &A, int i, int j, const Complex &c)
simth::Complex	c_det (const CMatrix &A)
Real-valued Matrix operations
Matrix	eye (int i)
Matrix	zeros (int i, int j)
Matrix	ones (int i, int j)
double	det (const Matrix &A)
Pseudo-complex Vector operations
const Complex &	c_assign (CVector &A, int i, const Complex &c)
Complex	c_access (const CVector &A, int i)
std::ostream &	c_print (std::ostream &s, const CVector &G)
int	c_size (const CVector &A)
const Complex &	c_add_s (CVector &a, int i, const Complex &c)
CVector	c_ones (int i)
CVector	c_zeros (int i)
Vector	zeros (int i)
Blas routines
All of these are originally defined inside the Blas++ headers. But there, they are (of course) only defined for real-valued vectors. Here we add versions that can deal with our pseudo-complex vectors and matrices and also Complex numbers.
void	Blas_Add_Mult (CVector &dy, const Complex &c, const CVector &dx)
void	Blas_Mult (CVector &dy, const Complex &c, const CVector &dx)
void	Blas_Scale (const Complex &c, CVector &dx)
Complex	Blas_Dot_Prod (const CVector &dx, const CVector &dy)
void	Blas_R1_Update (CMatrix &A, const CVector &dx, const CVector &dy, const Complex &alpha)
double	Blas_NormF (const CMatrix &A)
void	Mat_Add_Norm (Matrix &A, const CMatrix &B)
double	Mat_Norm1 (const Matrix &A)
Typedefs
typedef LaComplex	Complex
	We need a special complex type here. It has the necessary conversion operators to everything else.
typedef LaGenMatDouble	Matrix
	Matrix of real double values.
typedef LaVectorDouble	Vector
	Vector of real double values.
typedef LaGenMatComplex	CMatrix
	Matrix of complex double values.
typedef LaVectorComplex	CVector
	Vector of complex double values.
typedef MSequence< CMatrix, MSeqAttrT< CMatrix > >	CMatrixSeq
typedef MSequence< CMatrix, MFreqSeqAttrT< CMatrix > >	MatrixFreqSignal
typedef MSequence< CVector, VSeqAttrT< CVector > >	CVectorSeq
typedef MSequence< CVector, VTimeSeqAttrT< CVector > >	VectorTimeSignal
typedef MSequence< CMatrix, MTimeSeqAttrT< CMatrix > >	MatrixTimeSignal
Functions
std::ostream &	operator<< (std::ostream &os, const MIMOChannel &cha)
std::ostream &	operator<< (std::ostream &os, const Decoder &enc)
std::ostream &	operator<< (std::ostream &os, const Encoder &enc)
Variables
const double	DELAY_THRESHOLD = 0.001