matfaust::poly::FaustPoly Class Reference

Subclass of Faust specialized for orthogonal polynomial basis. More...

Public Member Functions
function	FaustPoly (varargin)
	Constructor. More...
function	next (self)
	Returns the next polynomial basis (one additional dimension compared to this one). More...
Public Member Functions inherited from matfaust::Faust
function	Faust (varargin)
	Creates a Faust from a list of factors or alternatively from a file. More...
function	delete (F)
	Deletes the Faust object F (destructor). More...
function	uplus (F)
	Returns + F. More...
function	uminus (F)
	Returns - F. More...
function	plus (varargin)
	Plus. More...
function	minus (varargin)
	Minus. More...
function	mrdivide (F, s)
	/ Slash or right Faust divide. More...
function	mtimes (F, A)
	Multiplies the Faust F by A which is a full matrix, a Faust object or a scalar. More...
function	full (F)
	The full matrix implemented by F. More...
function	isreal (F)
	Indicates if F is a real Faust or a complex Faust. More...
function	real (F)
	Returns the real part of the Faust F. More...
function	imag (F)
	Returns the imaginary part of the Faust F. More...
function	single (F)
	Returns a new Faust whose class is single. It allows to convert all the factors to single precision. More...
function	double (F)
	Returns a new Faust whose class is double. It allows to convert all the factors to double precision. More...
function	transpose (F)
	The transpose of F. More...
function	ctranspose (F)
	The conjugate transpose of F. More...
function	conj (F)
	The complex conjugate of F. More...
function	pruneout (F, varargin)
	Returns a Faust optimized by removing useless zero rows and columns as many times as needed. More...
function	optimize_memory (F)
	Optimizes a Faust by changing the storage format of each factor in order to optimize the memory size. More...
function	optimize (F, varargin)
	Returns a Faust optimized with Faust.pruneout, Faust.optimize_memory and Faust.optimize_time. More...
function	optimize_time (F, varargin)
	Returns a Faust configured with the quickest Faust-matrix multiplication mode (benchmark ran on the fly). More...
function	size (F, varargin)
	The size of F. More...
function	numel (F)
	The number of elements in F. More...
function	nbytes (F)
	Gives the memory size of the Faust in bytes. More...
function	end (F, k, n)
	The last index when slicing or indexing a Faust. More...
function	factors (F, ids, varargin)
	Returns the i-th factor or a new Faust composed of F factors whose indices are listed in indices. More...
function	left (F, i, varargin)
	Returns the left hand side factors of F from index 1 to i included (in 1-base index). More...
function	right (F, i, varargin)
	Returns the right hand side factors of F from index i to end (in 1-base index). More...
function	numfactors (F)
	The number of factors of F. More...
function	length (F)
	The number of factors of F. More...
function	replace (F, i, new_factor)
	Replaces the factor of index i by new_factor in a new Faust copy of F. More...
function	insert (F, i, new_factor)
	Inserts new_factor at index i in a new Faust copy of F. More...
function	issparse (F, varargin)
	Returns true if F factors are all sparse matrices false otherwise. More...
function	isdense (F)
	Returns true if F factors are all dense matrices/arrays false otherwise. More...
function	save (F, filepath)
	Saves the Faust F into a file. More...
function	subsref (F, S)
	Subscripted reference of a Faust. More...
function	disp (F)
	Displays information about F. More...
function	norm (F, varargin)
	The matrix norm of F. More...
function	power_iteration (F, varargin)
	Performs the power iteration algorithm to compute the greatest eigenvalue of the Faust. More...
function	normalize (F, varargin)
	Returns the normalized F. More...
function	nnz_sum (F)
	The total number of nonzeros in the factors of F. More...
function	density (F)
	The density of F such that nnz_sum(F) == density(F) * numel(F). More...
function	rcg (F)
	The Relative Complexity Gain of F. More...
function	cat (varargin)
	Concatenates F with n Faust objects or full/sparse matrices. More...
function	horzcat (varargin)
	Horizontal concatenation [F,A, B, … ] where F is a Faust and A, B, … are Faust objects or sparse/full matrix. More...
function	vertcat (varargin)
	Vertical concatenation [F;A;B;…] where F is a Faust and A, B, … are Faust objects or sparse/full matrices. More...
function	imagesc (F, varargin)
	Displays image of F full matrix and its factors. More...
function	mldivide (F, B)
	\ Backslash or left full(F) divide. More...
function	pinv (F)
	Pseudoinverse matrix of full(F). More...
function	complex (F)
	Converts F to a new complex Faust. More...
function	clone (F, varargin)
	Clones the Faust (in a new memory space). More...
function	device (F)
	Returns the Faust device ('cpu' or 'gpu'). More...
function	class (F)
	Returns the Faust class ('single' or 'double'). More...
function	get_handle (F)
	Returns the Faust F C++ native object pointer as an integer. More...

Static Public Member Functions
static function	poly_ (self, coeffs, X)
	Non documented (implementation backend). More...
Static Public Member Functions inherited from matfaust::Faust
static function	opt_butterfly (F)
	Optimizes any Faust composed of butterfly factors. More...
static function	isFaust (obj)
	Returns true if obj is a Faust object, false otherwise. More...
static function	load (filepath, varargin)
	Loads a Faust from a .mat file. More...
static function	load_native (filepath)
	Loads a Faust from a .mat file (native C++ version). More...

Additional Inherited Members
Protected Attributes inherited from matfaust::Faust
Property	matrix
	Underlying Faust native object handle. More...
Property	is_real
	See Faust.isreal. More...
Property	dev
	See Faust.device. More...
Property	dtype
	See Faust.class. More...

Detailed Description

Subclass of Faust specialized for orthogonal polynomial basis.

This class is used only for the native implementation of the poly functions.

Note

It is not advisable to use this class directly.

Constructor & Destructor Documentation

FaustPoly()

function matfaust::poly::FaustPoly::FaustPoly

(

varargin

)

Constructor.

Member Function Documentation

next()

function matfaust::poly::FaustPoly::next

(

self

)

Returns the next polynomial basis (one additional dimension compared to this one).

poly_()

static function matfaust::poly::FaustPoly::poly_ ( self  , coeffs  , X    )

static

Non documented (implementation backend).

---

The documentation for this class was generated from the following file:

• FaustPoly.m