MBO
 All Data Structures Files Functions Variables Typedefs Enumerations Modules Pages
Typedefs | Functions

Typedefs

typedef struct MboProdSpace_t * MboProdSpace
 Type for describing tensor product spaces.
 

Functions

MBO_EXPORT MboProdSpace mboProdSpaceCreate (MboLocInd dim)
 Create a MboProdSpace. More...
 
MBO_EXPORT void mboProdSpaceDestroy (MboProdSpace *h)
 Destroy a MboProdSpace. More...
 
MBO_EXPORT void mboProdSpaceMul (MboProdSpace h1, MboProdSpace *h2)
 Kronecker product of two spaces. More...
 
MBO_EXPORT MboProdSpace mboProdSpaceCopy (MboProdSpace h)
 Create a copy of a product space. More...
 
MBO_EXPORT MboGlobInd mboProdSpaceDim (MboProdSpace h)
 Dimension of a tensor product space. More...
 
MBO_EXPORT int mboProdSpaceSize (MboProdSpace h)
 Number of factor spaces. More...
 
MBO_EXPORT void mboProdSpaceGetDims (MboProdSpace h, int n, MboLocInd *dims)
 Returns the dimensions of the elementary subspaces of h. More...
 
MBO_EXPORT int mboProdSpaceEqual (MboProdSpace h1, MboProdSpace h2)
 Check product spaces for equality. More...
 
MBO_EXPORT int mboProdSpaceCheck (MboProdSpace h)
 Check internal integrety of a product space. More...
 

Detailed Description

Function Documentation

MBO_EXPORT int mboProdSpaceCheck ( MboProdSpace  h)

Check internal integrety of a product space.

Parameters
h
Returns
The number of errors found in h.
See also
MboProdSpace
MBO_EXPORT MboProdSpace mboProdSpaceCopy ( MboProdSpace  h)

Create a copy of a product space.

The returned MboProdSpace must be destroyed with mboProdSpaceDestroy.

Parameters
hThe product space to copy.
Returns
The copy of h.
See also
mboProdSpaceDestroy, MboProdSpace
MBO_EXPORT MboProdSpace mboProdSpaceCreate ( MboLocInd  dim)

Create a MboProdSpace.

The created product space has to be destroyed with mboProdSpaceDestroy.

Parameters
dimDimension of the product space.
Returns
Produc space
See also
MboProdSpace, mboProdSpaceDestroy
MBO_EXPORT void mboProdSpaceDestroy ( MboProdSpace h)

Destroy a MboProdSpace.

Parameters
hSpace to be destroyed.
See also
MboProdSpace, mboProdSpaceCreate
MBO_EXPORT MboGlobInd mboProdSpaceDim ( MboProdSpace  h)

Dimension of a tensor product space.

Parameters
hThe dimension of this space is computed.
Returns
The global dimension of h.
See also
MboProdSpace
MBO_EXPORT int mboProdSpaceEqual ( MboProdSpace  h1,
MboProdSpace  h2 
)

Check product spaces for equality.

Parameters
h1First space.
h2Second space.
Returns
A non-zero value if h1 == h2.
See also
MboProdSpace
MBO_EXPORT void mboProdSpaceGetDims ( MboProdSpace  h,
int  n,
MboLocInd dims 
)

Returns the dimensions of the elementary subspaces of h.

Parameters
hThe space.
nNumber of dimensions desired. The first n dimensions are returned in dims. If mboProdSpaceSize(h) is smaller than n only mboProdSpaceSize(h) values are written to dims.
dimsOn exit dims contains the first n dimensions. dims should point to space for n or mboProdSpaceSize(h) integers - whichever is smaller.
See also
MboProdSpace
MBO_EXPORT void mboProdSpaceMul ( MboProdSpace  h1,
MboProdSpace h2 
)

Kronecker product of two spaces.

h2 <- h1 * h2

Parameters
h1First operator for Kronecker product.
h2On input, the second operator for Kronecker product. On exit, h2 contains the product of h1 and h2.
See also
MboProdspace
MBO_EXPORT int mboProdSpaceSize ( MboProdSpace  h)

Number of factor spaces.

Parameters
hThe space.
Returns
Number of spaces.
See also
MboProdSpace