Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▼Nmatfaust	The FAuST Matlab Wrapper
►Ndemo	The matfaust demo namespace
Cbsl	Brain Source Localization demo
Cfft	FFT multiplication runtime comparison between DFT matrix-vector and Faust(FFT)-vector
Chadamard	The demo for the hierarchical factorization of Hadamard matrices
Cquickstart	The FAuST quickstart script, a good place to look at for a first tour
Cruntimecmp	Runtime comparison demo: Faust-vector and dense matrix-vector multiplications, differents RCGs, transpose
►Nfactparams	The module for the parametrization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)
CConstraintGeneric	This is the parent class for representing a factor constraint in FAuST factorization algorithms
CConstraintInt	This class represents an integer constraint on a matrix
CConstraintMat	This class represents a matrix-based constraint on a matrix
CConstraintName	This class defines the names for the sub-types of constraints into the ConstraintGeneric hierarchy of classes
CConstraintReal	This class represents a real constraint on a matrix
CMHTPParams	This class defines the set of parameters to run the MHTP-PAL4MSA algorithm
CParamsFact	The parent abstract class to represent the general factorization parameters
CParamsHierarchical	The parent class to set input parameters for the hierarchical factorization algorithm
CParamsHierarchicalDFT	The simplified parameterization class for factorizing a DFT matrix using the hierarchical factorization algorithm
CParamsHierarchicalNoResCons	A ParamsHierarchical specialization for which there is no residual constraints
CParamsHierarchicalRectMat	The simplified parameterization class for factorizing a rectangular matrix with the hierarchical factorization algorithm
CParamsHierarchicalRectMatNoResCons	This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no constraint on the residual factors (cf. matfaust.proj.proj_id)
CParamsHierarchicalSquareMat	This class is deprecated, please use ParamsHierarchicalWHT instead
CParamsHierarchicalWHTNoResCons	The simplified parameterization class for factorizing a Hadamard matrix with the hierarchical factorization algorithm
CParamsPalm4MSA	The class is to set input parameters for the Palm4MSA algorithm
CParamsPalm4msaWHT	This class is a simple parameterization of PALM4MSA to factorize a Hadamard matrix using the matfaust.proj.skperm proximity operator
CStoppingCriterion	This class defines a StoppingCriterion for the FAuST's algorithms
►Npoly	The matfaust module for polynomial basis as Faust objects
CFaustPoly	Subclass of Faust specialized for orthogonal polynomial basis
►Nproj	This module provides matrix projectors
Canticirc	Functor for the anti-circulant projector
Cblockdiag	Functor for the BLOCKDIAG projector
Ccirc	Functor for the CIRC projector
Cconst	Functor for the CONST projector
Chankel	Functor for the HANKEL projector
Cnormcol	Functor for the NORMCOL projector
Cnormlin	Functor for the NORMLIN projector
Cproj_gen	The parent abstract class to represent projectors (as functors)
Cproj_id	Functor for the ID projector
Cskperm	Functor for the SKPERM projector
Csp	Functor for the SP projector
Cspcol	Functor for the SPCOL projector
Csplin	Functor for the SPLIN projector
Csplincol	Functor for the SPLINCOL projector
Cspsymm	Functor for the SPSYMM projector
Csptril	Functor for the SPTRIL projector
Csptriu	Functor for the SPTRIU projector
Csupp	Functor for the the SUPP projector
Ctoeplitz	Functor for the TOEPLITZ projector
CFaust	FAuST Matlab wrapper main class for using multi-layer sparse transforms
CFaustMulMode	Enumeration class of all matrix chain multiplication methods available to multiply a Faust to a matrix or to compute Faust.full(). These methods are used by Faust.optimize_time()
▼Npyfaust	The FAuST Python Wrapper
►Ndemo	The pyfaust demo module
Cbsl	Brain Source Localization demo
Cfft	FFT multiplication runtime comparison between DFT matrix-vector and Faust(FFT)-vector
Chadamard	The demo for the hierarchical factorization of Hadamard matrices
Cquickstart	The FAuST quickstart script, a good place to look at for a first tour
Cruntimecmp	Runtime comparison demo: Faust-vector and dense matrix-vector multiplications, differents RCGs, transpose
►Nfactparams	The module for the parameterization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization). See also: pyfaust.fact.hierarchical, pyfaust.fact.palm4msa
CConstraintGeneric	This is the parent class for representing a factor constraint in FAuST factorization algorithms
CConstraintInt	This class represents an integer constraint on a matrix
CConstraintList	A helper class for constructing a list of consistent pyfaust.proj.proj_gen projectors or ConstraintGeneric objects
CConstraintMat	This class represents a matrix-based constraint to apply on a matrix
CConstraintName	This class defines the names for the sub-types of constraints into the ConstraintGeneric hierarchy of classes
CConstraintReal	This class represents a real constraint on a matrix
CMHTPParams	This class defines the set of parameters to run the MHTP-PALM4MSA algorithm
CParamsFact	The parent abstract class to represent the general factorization parameters
CParamsFactFactory	The factory for creating simplified FAuST hierarchical algorithm parameters (ParamsHierarchical)
CParamsHierarchical	The parent class to set input parameters for the hierarchical factorization algorithm
CParamsHierarchicalDFT	The simplified parameterization class for factorizing a DFT matrix using the hierarchical factorization algorithm
CParamsHierarchicalNoResCons	This class is a simplified ParamsHierarchical in which you define only the pyfaust.fact.hierarchical resulting Faust factors constraints
CParamsHierarchicalRectMat	The simplified parameterization class for factorizing a rectangular matrix with the hierarchical factorization algorithm (pyfaust.fact.hierarchical)
CParamsHierarchicalRectMatNoResCons	This parameter class is the same as ParamsHierarchicalRectMat except that there is no residual factor constraints (see ParamsHierachicalNoResCons)
CParamsHierarchicalSquareMat
CParamsHierarchicalWHT	The simplified parameterization class for factorizing a Hadamard matrix with the hierarchical factorization algorithm
CParamsHierarchicalWHTNoResCons	The simplified parameterization class for factorizing a Hadamard matrix with the hierarchical factorization algorithm
CParamsPalm4MSA	The class intents to set input parameters for the Palm4MSA algorithm
CParamsPalm4msaWHT
CStoppingCriterion	This class defines a StoppingCriterion for PALM4MSA algorithms
►Npoly	The pyfaust module for polynomial basis as Faust objects
CFaustPoly	Subclass of Faust specialized for orthogonal polynomial basis
►Nproj	This module provides matrix projectors
Canticirc	Functor for the anticirculant projector
Cblockdiag	Functor for the BLOCKDIAG projector
Ccirc	Functor for the CIRC(ulant) projector
Cconst	Functor for the CONST projector
Chankel	Functor for the HANKEL projector
Cnormcol	Functor for the NORMCOL projector
Cnormlin	Functor for the NORMLIN projector
Cproj_gen	The parent abstract class to represent projectors (as functors)
Cproj_id	Functor for the identity projector
Cskperm	Functor for the SKPERM projector
Csp	Functor for the SP projector
Cspcol	Functor for the SPCOL projector
Csplin	Functor for the SPLIN projector
Csplincol	Functor for the SPLINCOL projector
Cspsymm	Functor for the SYMM SP projector
Csptril	Functor for the SPTRIL projector
Csptriu	Functor for the SPTRIU projector
Csupp	Functor for the SUPP projector
Ctoeplitz	Functor for the TOEPLITZ projector
CFaust	pyfaust main class for using multi-layer sparse transforms
CFaustMulMode	Enumeration class of all matrix chain multiplication methods available to multiply a Faust to a matrix or to compute Faust.toarray()