Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ActivityStateUsed by commentator
BaseTimerBase for class RealTimer; class SysTimer; class UserTimer;
BitVector
BlackboxArchetypeShowing the member functions provided by all blackbox matrix classes
BlackboxBlockContainerBaseA base class for BlackboxBlockContainer. The primary member function is begin()
BlackboxContainerLimited doc so far
BlackboxContainerBaseA base class for BlackboxContainer. The primary member function is begin()
BlackboxContainerSymmetricSee base class for doc
BlackboxContainerSymmetrizeSymmetrizing iterator (for rank computations)
BlackboxFactoryA tool for computations with integer and rational matrices
BlackboxInterfaceThis blackbox base class exists solely to aid documentation organization
BlasBlackboxDense matrix representation for BLAS based elimination.

A BlasBlackbox can be constructed from any blackbox matrix. This costs n blackbox matrix vector products in general, but is efficiently done from a DenseMatrix or SparseMatrix

BlasMatrixDomainMulAdd
BlockLanczosSolverBlock Lanczos iteration
BlockMasseyDomainCompute the linear generator of a sequence of matrices
BlockRing
BlockRing::ElementDefault constructable wrapper for BlasMatrix
BooleanSwitch
BooleanSwitchFactory
ButterflySwitching Network based BlackBox Matrix. A good preconditioner
CekstvSwitch
CekstvSwitchFactory
CommentatorGive information to user during runtime

This object is used for reporting information about a computation to the user. Such information includes errors and warnings, descriptions of internal progress, performance measurements, and timing estimates. It also includes facilities for controlling the type and amount of information displayed

CompanionCompanion matrix of a monic polynomial
ComposeBlackbox of a product: C := AB, i.e. Cx := A(Bx)
Compose< _Blackbox, _Blackbox >Specialization for _Blackbox1 = _Blackbox2
ComposeTraitsUsed in ..., for example
ComposeTraits< DenseMatrix< Field > >Used in smith-binary, for example
ConstantVectorStream
DenseContainerLimited doc so far
DenseMatrixBlackbox interface to dense matrix representation
DenseMatrixBase
DenseMatrixFactory
DenseRowsMatrix
DenseSubmatrix
DiagonalRandom diagonal matrices are used heavily as preconditioners
Diagonal< _Field, VectorCategories::DenseVectorTag >Specialization of Diagonal for application to dense vectors
Diagonal< Field, VectorCategories::SparseAssociativeVectorTag >Specialization of Diagonal for application to sparse associative vectors
Diagonal< Field, VectorCategories::SparseSequenceVectorTag >Specialization of Diagonal for application to sparse sequence vectors
DifBlackbox of a difference: C := A - B, i.e. Cx = Ax - Bx
DiophantineSolverDiophantineSolver<QSolver> creates a diophantine solver using a QSolver to generate rational solutions
DirectSumIf C = DirectSum(A, B) and y = xA and z = wB, then (y,z) = (x,w)C
ElementAbstractAbstract element base class, a technicality
ElementArchetypeField and Ring element interface specification and archetypical instance class.

Element classes must contain public default constructor, copy constructor, assignment operator, and destructor. Note that primitive types such as int and double meet this specification

ElementEnvelopeAdaptor from archetypical interface to abstract interface, a technicality
Eliminator
FFPACKSet of elimination based routines for dense linear algebra with matrices over finite prime field of characteristic less than 2^26
FieldAbstractField base class.

Found in the file {linbox/field/abstract.h}. Abstract base class used to implement the field archetype to minimize code bloat. All public member functions of this class are purely virtual and must be implemented by all derived classes

FieldArchetypeField specification and archetypical instance.

The FieldArchetype and its encapsulated element class contain pointers to the FieldAbstract and its encapsulated field element, respectively. FieldAbstract then uses virtual member functions to define operations on its encapsulated field element. This field element has no knowledge of the field properties being used on it which means the field object must supply these operations

FieldAXPY
FieldEnvelopeDerived class used to implement the field archetype

Helps to minimize code bloat. This class implements all purely virtual member functions of the abstract base class. This class is used to wrap a LinBox field so that it might be used with the Field archetype

FieldInterfaceThis field base class exists solely to aid documentation organization
FieldIODummy field for conceptually unclear io
GaussDomainRepository of functions for rank by elimination on sparse matrices
GivaroExtension
GivaroExtension< GivaroGfq >
GivaroFieldGive LinBox fields an allure of Givaro Fields

This class adds the necessary requirements allowing the construction of an extension of a LinBox field

GivaroGfq
GivaroMontgWrapper of Givaro's Montgomery<Std32>.

This class is a modular representation with a Montgomery reduction

GivaroZpzWrapper of Givaro's ZpzDom.

Most methods are inherited from ZpzDom<Std16>, ZpzDom<Std32> and ZpzDom<log16> classes of Givaro. These classes allow to construct only finite field with a prime modulus

GivPolynomialPolynomials over a domain
GivPolynomialRingPolynomials with coefficients modulo some power of two
GmpRandomPrimeGenerating random prime integers, using the gmp library
GMPRationalElementElements of GMP_Rationals
HilbertExample of a blackbox that is space efficient, though not time efficient
Hilbert_JIT_EntryThe object needed to build a Hilbert matrix as a JIT matrix
HomMap element of source ring(field) to target ring

An instance of Hom is a homomorphism from a ring of type Source to a ring (usually field) of type Target. The intended use is that it will be a natural mapping. For instance:

InconsistentSystem
indexDomain
InvalidMatrixInput
InverseA Blackbox for the inverse. Not efficient if many applications are used.

The matrix itself is not stored in memory. Rather, its apply methods use a vector of field elements, which are used to "multiply" the matrix to a vector

JIT_MatrixExample of a blackbox that is space efficient, though not time efficient
LABlockLanczosSolver
LanczosSolverSolve a linear system using the conjugate Lanczos iteration
LastInvariantFactorThis is used in a Smith Form algorithm
LidiaGfqDefines the Galois Field GF(pk)
LinboxError
Local2_32Fast arithmetic mod 2^32, including gcd
MasseyDomainBerlekamp/Massey algorithm
MatrixArchetypeDirectly-represented matrix archetype
MatrixCategoriesFor specializing matrix arithmetic
MatrixDomainClass of matrix arithmetic functions
MatrixRank
MatrixStreamReader
MessageClass
MethodMethod specifiers for controlling algorithm choice
MGBlockLanczosSolverBlock Lanczos iteration
ModularPrime fields of positive characteristic implemented directly in LinBox
Modular< int16 >Specialization of Modular to short element type with efficient dot product
Modular< int32 >Specialization of Modular to int32 element type with efficient dot product
Modular< int8 >Specialization of Modular to signed 8 bit element type with efficient dot product
Modular< uint16 >Specialization of class Modular for uint16 element type
Modular< uint32 >Specialization of class Modular for uint32 element type
Modular< uint8 >Allows compact storage when the modulus is less than 2^8
ModularBalancedRandIter
ModularRandIter
MoorePenroseGeneralized inverse of a blackbox. Efficiency concerns when many applications are used
MVProductDomainHelper class to allow specializations of certain matrix-vector products
NoHomErrorError object for attempt to establish a Hom that cannot exist
NonzeroRandIter
NTL_PID_zz_pExtend Wrapper of zz_p from NTL. Add PID functions
NTL_ZZInteger ring
NTL_zz_pLong ints modulo a positive integer
NTL_zz_pEFor large cardinality, small prime
NTL_zz_pX
NTL_ZZ_pX
NullMatrixThis is a representation of the 0 by 0 empty matrix which does not occupy memory. It has it's uses!
OneInvariantFactorLimited doc so far
PairPair of I and T : struct { column index, value }
ParamFuzzy
PermutationSize is n
PIR_ntl_ZZ_pExtend Wrapper of ZZ_p from NTL. Add PIR functions
PolynomialBBRepresent the matrix P(A) where A is a blackbox and P a polynomial
PowerGaussDomainRepository of functions for rank modulo a prime power by elimination on sparse matrices
PowerOfTwoModularRing of elements modulo some power of two
PowerOfTwoModular::RandIter
PrimeStream
RandIterAbstract
RandIterArchetypeRandom field element generator archetype
RandIterEnvelope
RandomDenseStream
RandomSparseStream
RationalReconstructionLimited doc so far. Used, for instance, after LiftingContainer
RationalRemainderChinese remainder of rationals
RationalSolverInterface for the different specialization of p-adic lifting based solvers
RationalSolver< Ring, Field, RandomPrime, BlockWiedemannTraits >Partial specialization of p-adic based solver with block Wiedemann algorithm
RationalSolver< Ring, Field, RandomPrime, DixonTraits >Partial specialization of p-adic based solver with Dixon algorithm
RationalSolver< Ring, Field, RandomPrime, NumericalTraits >Partial specialization of p-adic based solver with a hybrid Numeric/Symbolic computation
RationalSolver< Ring, Field, RandomPrime, WiedemannTraits >Partial specialization of p-adic based solver with Wiedemann algorithm
RawVector
RebindUsed in support of Hom, MatrixHom
ReverseVector
RingAbstractAbstract ring base class.

Found in the file {linbox/ring/abstract.h}. Abstract base class used to implement the ring archetype to minimize code bloat. All public member functions of this class are purely virtual and must be implemented by all derived classes

RingArchetypeSpecification and archetypic instance for the ring interface

The {RingArchetype} and its encapsulated element class contain pointers to the {RingAbstract} and its encapsulated ring element, respectively. {RingAbstract} then uses virtual member functions to define operations on its encapsulated ring element. This ring element has no knowledge of the ring properties being used on it which means the ring object must supply these operations

RingEnvelopeImplement the ring archetype to minimize code bloat.

This class implements all purely virtual member functions of the abstract base class. This class is used to wrap a {LinBox} ring so that it might be used with the Ring archetype

RingInterfaceThis ring base class exists solely to aid documentation organization
ScalarMatrixBlackbox for aI. Use particularly for representing 0 and I
SmithFormBinaryCompute Smith form
SmithFormIliopoulosThis is Iliopoulos' algorithm do diagonalize
SmithFormLocalSmith normal form (invariant factors) of a matrix over a local ring
SolveFailed
SolverTraits
Sparse_VectorVector< Pair<T> > and actualsize
SparseMatrixVector of sparse rows
SparseMatrixBase
SparseMatrixFactory
StandardBasisStream
SubiteratorSubvector iterator class provides striding iterators.

A Subiterator steps by a fixed stride thru the underlying container. Subiter<Iterator> requires that Iterator be a random access iterator class and then itself provides the full functionality of a random access iterator class. See STL documentation for that functionality. Documented here is only the constructor from (1) an iterator of an underlying container and (2) a stride amount

SubmatrixLeading principal minor of existing matrix without copying
Submatrix< Blackbox, VectorCategories::DenseVectorTag >
Submatrix< DenseMatrix< _Field >, VectorCategories::DenseVectorTag >
SubvectorDense subvector

This class provides a statically sized subvector of a random access container (such as std::vector, deque). It does not work on sparse linbox vectors. It implements all of the types and methods of a std::vector except for those that invalidate iterators, i.e., those (potentially) involving vector resizing, such as push_back(), insert(), resize()

SumBlackbox of a matrix sum without copying
Sylvester
ToeplitzThis is the blackbox representation of a Toeplitz matrix
Toeplitz< typename _PField::CoeffField, _PField >
TransposeTranspose matrix without copying
TransposeMatrix
TriplesBBWrapper for NAG Sparse Matrix format
UnparametricRandIter
VectorCategoriesList of vector categories
VectorFractionVectorFraction<Domain> is a vector of rational elements with common reduced denominator. Here Domain is a ring supporting the gcd, eg NTL_ZZ or PID_integer For compatability with the return type of rationalSolver, it allows conversion from/to std::vector<std::pair<Domain::Element> >. All functions will return the fraction in reduced form, calling reduce() if necessary
VectorStreamVector factory
VectorTraits
WiedemannSolverLinear system solvers based on Wiedemann's method
ZeroOneTime and space efficient representation of sparse {0,1}-matrices

Generated on Wed Dec 10 07:49:48 2008 for linbox by  doxygen 1.5.7.1