TSparseMtx Members

The following tables list the members exposed by TSparseMtx.

	Name	Description
	Ai	This is Ai, a member of class TSparseMtx.
	Alfa	Additional parameter for certain Lapack methods.
	Ap	This is Ap, a member of class TSparseMtx.
	Beta	Additional parameter for certain Lapack methods.
	CData	This is CData, a member of class TMtxVecSample.
	Control	This is Control, a member of class TSparseMtx.
	CValues	Allows setting/getting the complex value at position Indx.
	CValues1D	Allows setting/getting the complex value at position Indx.
	Info	This is Info, a member of class TSparseMtx.
	SCData	This is SCData, a member of class TMtxVecSample.
	SControl	This is SControl, a member of class TSparseMtx.
	SCValues	Allows setting/getting the complex value at position Indx.
	SCValues1D	Allows setting/getting the complex value at position Indx.
	SData	This is SData, a member of class TMtxVecSample.
	SInfo	This is SInfo, a member of class TSparseMtx.
	SSData	This is SSData, a member of class TMtxVecSample.
	SValues	Allows setting/getting the real value at position Indx.
	SValues1D	Allows setting/getting the real value at position Indx.
	Values	Allows setting/getting the real value at position Indx.
	Values1D	Allows setting/getting the real value at position Indx.

Public Methods

	Name	Description
	Abs	This is the overview for the Abs method overload.
	Add	This is the overview for the Add method overload.
	AddSplit	This is the overview for the AddSplit method overload.
	Adjung	Adjungate operation.
	AfterConstruction	This is AfterConstruction, a member of class TMtxVecBase.
	ArcCos	This is the overview for the ArcCos method overload.
	ArcCosh	This is the overview for the ArcCosh method overload.
	ArcCot	This is the overview for the ArcCot method overload.
	ArcCoth	This is the overview for the ArcCoth method overload.
	ArcCsc	This is the overview for the ArcCsc method overload.
	ArcCsch	This is the overview for the ArcCsch method overload.
	ArcSec	This is the overview for the ArcSec method overload.
	ArcSech	This is the overview for the ArcSech method overload.
	ArcSin	This is the overview for the ArcSin method overload.
	ArcSinh	This is the overview for the ArcSinh method overload.
	ArcTan	This is the overview for the ArcTan method overload.
	ArcTan2	This is the overview for the ArcTan2 method overload.
	ArcTanh	This is the overview for the ArcTanh method overload.
	BandedToSparse	Converts banded matrix to modified compressed column sparse matrix format.
	BeforeDestruction	This is BeforeDestruction, a member of class TMtxVecBase.
	BinarySearch	This is the overview for the BinarySearch method overload.
	BlockFinish	Deinitializes block processing before the final block is processed.
	BlockInit	This is the overview for the BlockInit method overload.
	BlockNext	Obtains the next subrange of the data.
	BlockSubRangeLevel	Returns the current subrange stack level used by block processing functions.
	CartToPolar	This is the overview for the CartToPolar method overload.
	Cbrt	This is the overview for the Cbrt method overload.
	CDataIndex	Returns an index pointing to element at Index for TCplx data.
	Ceil	This is the overview for the Ceil method overload.
	Clear	Sets vector size to zero.
	CondDisable	Saves the current value of ConditionCheck property and sets it to false.
	CondEnable	Sets the ConditionCheck property to whatever it was before the CondDisable was used.
	Conj	This is the overview for the Conj method overload.
	ConjMul	Conjugate Sparse2 and matrix multiply it with Sparse1.
	Copy	Copies sparse matrix from Src to the calling object.
	Copy	This is the overview for the Copy method overload.
	CopyFromArray	This is the overview for the CopyFromArray method overload.
	CopyTo	Copies sparse matrix from Src to the calling object.
	CopyTo	This is the overview for the CopyTo method overload.
	CopyToArray	This is the overview for the CopyToArray method overload.
	CopyToArray	This is the overview for the CopyToArray method overload.
	Cos	This is the overview for the Cos method overload.
	Cosh	This is the overview for the Cosh method overload.
	Cot	This is the overview for the Cot method overload.
	Coth	This is the overview for the Coth method overload.
	CplxToReal	This is the overview for the CplxToReal method overload.
	Create	This is Create, a member of class TSparseMtx.
	Csc	This is the overview for the Csc method overload.
	Csch	This is the overview for the Csch method overload.
	DegToRad	This is the overview for the DegToRad method overload.
	DenseToSparse	Convert dense matrix to sparse matrix format.
	Destroy	This is Destroy, a member of class TSparseMtx.
	Diag	Copies the kk-th diagonal of TSparseMtx to the Vec object.
	DiagonalsCount	Calculates the number of diagonals above and below main diagonal.
	DisableSelect	Prevents calls to Select.
	DisableSubrange	Prevents calls to SetSubRange.
	DivideElem	Divide individual elements of sparse matrices.
	EigSym	Computes eigenvalues and eigenvectors for symmetric (hermitian) sparse matrix.
	EigSymGen	Computes eigenvalues and eigenvectors for generalized symmetric (hermitian) sparse problem.
	EnableSelect	Enables calls to Select.
	EnableSubrange	Enables calls to SetSubRange.
	Equal	This is the overview for the Equal method overload.
	Erf	This is the overview for the Erf method overload.
	Erfc	This is the overview for the Erfc method overload.
	ErfInv	This is the overview for the ErfInv method overload.
	Exp	This is the overview for the Exp method overload.
	Exp10	This is the overview for the Exp10 method overload.
	Exp2	This is the overview for the Exp2 method overload.
	ExpandSymmetric	Form a full symmetric matrix from upper half with diagonal included.
	Expj	This is the overview for the Expj method overload.
	ExtendToComplex	This is the overview for the ExtendToComplex method overload.
	Find	This is the overview for the Find method overload.
	FixAngle	This is the overview for the FixAngle method overload.
	Flip	This is the overview for the Flip method overload.
	FlipConj	This is the overview for the FlipConj method overload.
	Floor	This is the overview for the Floor method overload.
	Frac	This is the overview for the Frac method overload.
	FreeNumeric	Frees the numeric object used by the Umfpack.
	FreePardiso	Frees the memory of the Pardiso solver.
	FreeSymbolic	Frees the symbolic object used by the Umfpack.
	FreeTaucs	Releases factorization stored by taucs.
	FreeToCache	Frees the object.
	ImagPart	This is the overview for the ImagPart method overload.
	IntPower	This is the overview for the IntPower method overload.
	Inv	The inverse matrix.
	Inv	This is the overview for the Inv method overload.
	InvCbrt	This is the overview for the InvCbrt method overload.
	InvSqrt	This is the overview for the InvSqrt method overload.
	IsComplex	This is IsComplex, a member of class TMtxVec.
	IsEqual	This is the overview for the IsEqual method overload.
	IsEqualSize	Compares matrix size.
	Ln	This is the overview for the Ln method overload.
	LoadFromFile	Reads the header information and the values array content from the file.
	LoadFromMatrixMarketFile	Loads the matrix stored in a matrix market file format.
	LoadFromStream	Reads the header information and the values array content from a stream.
	Log10	This is the overview for the Log10 method overload.
	Log2	This is the overview for the Log2 method overload.
	LogN	This is the overview for the LogN method overload.
	LowerTriangle	Extract lower part of the Mtx.
	Mag	This is the overview for the Mag method overload.
	Max	Maximum of all non-zero elements.
	Maxc	Maximum of all non-zero complex elements.
	Mean	Average of all non-zero elements.
	MeanAndStdDev	This is the overview for the MeanAndStdDev method overload.
	Meanc	Average of all non-zero complex elements.
	Min	Minimum of all non-zero elements.
	Minc	Minimum of all non-zero complex elements.
	Mul	Multiply two sparse matrices (matrix multiplication).
	Mul	This is the overview for the Mul method overload.
	MulI	This is the overview for the MulI method overload.
	MulLeft	This is the overview for the MulLeft method overload.
	MulRight	This is the overview for the MulRight method overload.
	Normalize	This is the overview for the Normalize method overload.
	PCValues1D	Obtaines a pointer to the complex value of the vector at Index.
	PhaseSpectrum	This is the overview for the PhaseSpectrum method overload.
	PixelDownSample	Reduces dense matrix for screen display (bitmap) to show the non-zero pattern.
	PolarToCart	This is the overview for the PolarToCart method overload.
	Power	This is the overview for the Power method overload.
	PowerSpectrum	This is the overview for the PowerSpectrum method overload.
	PowerVec	Raises Base object elements to Exponent object elements power.
	PrecisionEPS	EPS = 2.220446049250313E-16;
	PrecisionMaxValue	1.797693134862315E+308;
	PrecisionMinValue	2.225073858507202E-308;
	PrecisionSqrtEPS	1.4901161194e-08;
	Product	This is the overview for the Product method overload.
	Productc	This is the overview for the Productc method overload.
	PSCValues1D	Obtaines a pointer to the complex value of the vector at Index.
	PSValues1D	Obtains a pointer to the real value of the vector at Index.
	PValues1D	Obtains a pointer to the real value of the vector at Index.
	RadToDeg	This is the overview for the RadToDeg method overload.
	RandGauss	This is the overview for the RandGauss method overload.
	RandomSparse	Creates quadratic non-complex non-singular sparse matrix.
	RandUniform	This is the overview for the RandUniform method overload.
	ReadHeader	Reads the header information from a stream to object.
	ReadValues	Read values content from stream to object.
	RealPart	This is the overview for the RealPart method overload.
	RealToCplx	This is the overview for the RealToCplx method overload.
	Rem	This is the overview for the Rem method overload.
	Replace	This is the overview for the Replace method overload.
	Reset	Resets object properties to default values.
	Reset	For internal use only. Used to return object to cache.
	ResidualNorm	The residual norm of the solution of the system of linear equations A*X=B.
	Resize	Resizes the sparse matrix to a new number of non-zeros.
	RMS	Root mean squared of all non-zero elements.
	RMS	This is the overview for the RMS method overload.
	Round	This is the overview for the Round method overload.
	SaveToFile	Write object header and values to a file.
	SaveToMatrixMarketFile	Saves the matrix in matrix market file format.
	SaveToStream	Writes the header information and the Values content to a stream.
	Scale	This is the overview for the Scale method overload.
	Scatter	Scatter object elements.
	ScatterByIncr	Scatters Src elements starting at Offset and with Increment to the calling object.
	ScatterByIndexes	Scatters Src elements defined with indices stored in Indexes to the calling object.
	ScatterByMask	Scatters Src elements defined with the Mask to the calling object.
	SDataIndex	Returns an index pointing to element at Index for double data.
	Sec	This is the overview for the Sec method overload.
	Sech	This is the overview for the Sech method overload.
	Select	This is the overview for the Select method overload.
	SelectAll	Resets any defined selection.
	SetCplx	Sets object complex values.
	SetDouble	This is the overview for the SetDouble method overload.
	SetFullRange	Resets subrange defined with SetSubRange.
	SetFullRangeLevel	Pops the current subrange stack one level up.
	SetInteger	This is the overview for the SetInteger method overload.
	SetIt	This is the overview for the SetIt method overload.
	SetSingle	This is the overview for the SetSingle method overload.
	SetSubIndex	Defines a subarray.
	SetSubRange	This is the overview for the SetSubRange method overload.
	SetSubRangeLevel	This is the overview for the SetSubRangeLevel method overload.
	SetVal	This is the overview for the SetVal method overload.
	SetZero	This is the overview for the SetZero method overload.
	Sgn	This is the overview for the Sgn method overload.
	SgnMul	Signum.
	Sign	This is the overview for the Sign method overload.
	Sin	This is the overview for the Sin method overload.
	SinCos	This is the overview for the SinCos method overload.
	Sinh	This is the overview for the Sinh method overload.
	SinhCosh	This is the overview for the SinhCosh method overload.
	Size	This is the overview for the Size method overload.
	Size	This is the overview for the Size method overload.
	SizeToArray	This is the overview for the SizeToArray method overload.
	SizeToArray	This is the overview for the SizeToArray method overload.
	Solve	This is the overview for the Solve method overload.
	SolveIterative	This is the overview for the SolveIterative method overload.
	SparseToBanded	Convert sparse matrix to banded matrix.
	SparseToDense	Convert sparse matrix to banded matrix.
	SparseToTriplets	This is the overview for the SparseToTriplets method overload.
	Split	Split sparse matrix into lower triangle, main diagonal and upper triangle.
	Sqr	This is the overview for the Sqr method overload.
	Sqrt	This is the overview for the Sqrt method overload.
	StdDev	This is the overview for the StdDev method overload.
	StringsToValues	Convert strings to specific matrix format.
	StructurizeSymmetric	Required by Pardiso solver to solve for general matrices.
	Sub	Subract two sparse matrices.
	SubRangeLevel	Returns the current subrange stack level.
	Sum	This is the overview for the Sum method overload.
	Sumc	This is the overview for the Sumc method overload.
	Tan	This is the overview for the Tan method overload.
	Tanh	This is the overview for the Tanh method overload.
	ThreshAbsGT	This is the overview for the ThreshAbsGT method overload.
	ThreshAbsLT	This is the overview for the ThreshAbsLT method overload.
	ThreshBottom	This is the overview for the ThreshBottom method overload.
	ThresholdGT	This is the overview for the ThresholdGT method overload.
	ThresholdGT_LT	This is the overview for the ThresholdGT_LT method overload.
	ThresholdLT	This is the overview for the ThresholdLT method overload.
	ThreshTop	This is the overview for the ThreshTop method overload.
	Transp	This is the overview for the Transp method overload.
	TripletsToSparse	This is the overview for the TripletsToSparse method overload.
	TripletsToSparseAndFlush	Construct a sparse matrix by specifying the position of each element in dense matrix.
	Trunc	This is the overview for the Trunc method overload.
	TruncAndFrac	This is the overview for the TruncAndFrac method overload.
	UpperTriangle	Extract upper part of the Mtx.
	ValuesToStrings	Convert matrix values to strings.
	WriteHeader	This is the overview for the WriteHeader method overload.
	WriteValues	This is the overview for the WriteValues method overload.
	ZeroThresh	Reduces the number of non-zeros.

Public Properties

	Name	Description
	ActualIters	Returns the number of actual iterations performed by Solve.
	BackError	Holds the backward or iterative stopping criteria.
	BlockEnd	Returns true, if the currrent subrange of the vector was also the last subrange in the vector.
	CacheIndex	For internal use only. Read to get the index of this object in object cache.
	Capacity	Sizing the object will not allocate less than Capacity.
	CapacityInBytes	Sizing the object will not allocate less than CapacityInBytes.
	CapacityInElements	Sizing the object will not allocate less than CapacityInElements.
	CapacityStep	Specifies increment step for the Capacity property.
	CValue	Allows setting and getting double precision complex values.
	DefaultArray	Allows setting/getting the real value at position Indx.
	Dirty	True after object property changes.
	FloatPrecision	Defines the precision (single, float) and type (real, complex) of the floating point operations.
	FloatPrecisionLock	This is FloatPrecisionLock, a member of class TMtxVecSample.
	IsDouble	Defines the precision (single or double) of the floating point operations.
	IsSubRange	Set to true after the SetSubIndex or SetSubRange call.
	MtxError	Holds the error string, if an error has occurred.
	OnSetSize	Called when object size changes.
	PoolIndex	Internal.
	Precision	Defines the precision used by streaming routines.
	Rounding	Defines the rounding used by streaming routines.
	SCValue	Allows setting and getting single precision complex values.
	SparsePattern	Defines the pattern used when solving a system of linear equations.
	SValue	Allows setting and single precision values.
	Value	Allows setting and getting value at position Row and Col.
	ZeroTolerance	The tolerance used by IsEqual.

Published Properties

	Name	Description
	AutoClearReport	Defines if call to Solve will clear the report.
	Caption	Caption.
	Cols	Number of columns in the sparse matrix.
	Complex	Defines if object values are complex.
	ConditionCheck	Enables/disable inline condition checking.
	ConvergenceCheck	Convergence criteria for iterative method.
	DontStripZeros	Prevents zeros to be stripped.
	First	First element in object Values array.
	Firstc	First element in object CValues array.
	IterativeMethod	Defines the iterative method for solving system of equations.
	Last	Last element in object Values array.
	Lastc	Last complex element in object CValues array.
	Length	Defines the length in number of samples.
	MaxIters	Upper limit for number of iterations.
	NonZeros	Defines the number of non-zero elements in the sparse matrix.
	Pardiso	The pardiso sparse solver settings.
	RefinmentIters	Defines number of refinement steps the Solve method should try.
	ReportLevel	Defines how detailed report will be printed.
	Rows	Number of rows in the sparse matrix.
	SparseBlockSize	The size of the block as used by UmfPack.
	SparseSolver	Specifies the sparse matrix solver to use.
	SparseSystem	Defines the system to be solved by the Solve method.
	Tag	Stores an integer value as part of a TMtxVec object.
	Taucs	The Taucs sparse solver settings.
	Tolerance	Defines the tolerance for iterative method.
	VectorCount	Defines maximum number of vectors used in some iterative methods.

Links

TSparseMtx Class, Legend, Public Fields, Public Methods, Public Properties, Published Properties

What do you think about this topic? Send feedback!