org.jquantlib.math.matrixutilities.internal

Interface Address

All Known Subinterfaces:

Address.ArrayAddress, Address.MatrixAddress

All Known Implementing Classes:

DirectAddress, DirectArrayColAddress, DirectArrayRowAddress, DirectMatrixAddress, MappedAddress, MappedMatrixAddress

public interface Address

This is the main interface responsible for Matrix and Array accessors

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Address.ArrayAddress This interface defines Array accessors
static class	Address.Flags
static interface	Address.MatrixAddress This interface defines Matrix accessors
static interface	Address.Offset This is the main interface responsible for generation of Iterators associated to classes Matrix and Array

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GAP_INDEX_FOUND
static java.lang.String	INVALID_BACKWARD_INDEXING
static java.lang.String	INVALID_COLUMN_INDEX
static java.lang.String	INVALID_ROW_INDEX

Method Summary

Modifier and Type	Method and Description
int	base()
int	col0() col0 is the row offset of the leftmost column of a Matrix.
int	cols()
java.util.Set<Address.Flags>	flags()
boolean	isContiguous() Tells if the underlying memory storage can be accessed in a continuous way.
boolean	isFortran() This is a convenience method intended to return Address.Flags.FORTRAN
int	last()
int	row0() row0 is the row offset of the upmost row of a Matrix.
int	rows()

Field Detail

INVALID_BACKWARD_INDEXING

static final java.lang.String INVALID_BACKWARD_INDEXING

See Also:

Constant Field Values

INVALID_ROW_INDEX

static final java.lang.String INVALID_ROW_INDEX

See Also:

Constant Field Values

INVALID_COLUMN_INDEX

static final java.lang.String INVALID_COLUMN_INDEX

See Also:

Constant Field Values

GAP_INDEX_FOUND

static final java.lang.String GAP_INDEX_FOUND

See Also:

Constant Field Values

Method Detail

rows

int rows()

Returns:

the number of rows mapped

cols

int cols()

Returns:

the number of columns mapped

base

int base()

Returns:

the base address (inclusive)

last

int last()

Returns:

the last address (exclusive)

row0

int row0()

row0 is the row offset of the upmost row of a Matrix.

Example: Matrix B, being a sub-matrix of A, has row0 like shown below:

     Matrix A = new Matrix(5, 8);
     int row0 = 1; int row1 = 4;
     int col0 = 5; int col1 = 8;
     Matrix B = A.range(row0, row1, col0, col1);
 

Returns:

col0

int col0()

col0 is the row offset of the leftmost column of a Matrix.

Example: Matrix B, being a sub-matrix of A, has col0 like shown below:

     Matrix A = new Matrix(5, 8);
     int row0 = 1; int row1 = 4;
     int col0 = 5; int col1 = 8;
     Matrix B = A.range(row0, row1, col0, col1);
 

Returns:

isContiguous

boolean isContiguous()

Tells if the underlying memory storage can be accessed in a continuous way.

When contiguous is true, certain operations are benefited by bulk operations.

isFortran

boolean isFortran()

This is a convenience method intended to return Address.Flags.FORTRAN

Returns:

Flags#FORTRAN

flags

java.util.Set<Address.Flags> flags()

Returns:

a set of flags in effect on this Address object.