HMatrixParameters

class HMatrixParameters(*args)

Parameters for HMatrix class.

Notes

This class regroups the parameters used by HMatrix

Methods

getAdmissibilityFactor() Return the admissibility factor used for cluster blocks.
getAssemblyEpsilon() Return the epsilon used for the assembly.
getClassName() Accessor to the object’s name.
getClusteringAlgorithm() Return the clustering algorithm.
getCompressionMethod() Return the compression method.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getRecompressionEpsilon() Return the epsilon used for the recompression.
getShadowedId() Accessor to the object’s shadowed id.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setAdmissibilityFactor(admissibilityFactor) Set the admissibility factor used for cluster blocks.
setAssemblyEpsilon(assemblyEpsilon) Set the epsilon used for the assembly.
setClusteringAlgorithm(clusteringAlgorithm) Set the clustering algorithm.
setCompressionMethod(compressionMethod) Set the compression method.
setName(name) Accessor to the object’s name.
setRecompressionEpsilon(recompressionEpsilon) Set the epsilon used for the recompression.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)
getAdmissibilityFactor()

Return the admissibility factor used for cluster blocks.

Returns:

epsilon : float

admissibility factor for HMatrix.

getAssemblyEpsilon()

Return the epsilon used for the assembly.

Returns:

epsilon : float

assembly epsilon for HMatrix.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getClusteringAlgorithm()

Return the clustering algorithm.

Returns:

algorithm : str

clustering algorithm (either ‘median’, ‘geometric’ or ‘hybrid’).

getCompressionMethod()

Return the compression method.

Returns:

method : str

compression method (either ‘SVD’, ‘ACA full’, ‘ACA partial’ or ‘ACA+’.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getRecompressionEpsilon()

Return the epsilon used for the recompression.

Returns:

epsilon : float

recompression epsilon for HMatrix.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

setAdmissibilityFactor(admissibilityFactor)

Set the admissibility factor used for cluster blocks.

Parameters:

epsilon : float

admissibility factor for HMatrix.

setAssemblyEpsilon(assemblyEpsilon)

Set the epsilon used for the assembly.

Parameters:

epsilon : float

assembly epsilon for HMatrix.

setClusteringAlgorithm(clusteringAlgorithm)

Set the clustering algorithm.

Parameters:

algorithm : str

clustering algorithm (either ‘median’, ‘geometric’ or ‘hybrid’).

setCompressionMethod(compressionMethod)

Set the compression method.

Parameters:

method : str

compression method (either ‘SVD’, ‘ACA full’, ‘ACA partial’ or ‘ACA+’.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setRecompressionEpsilon(recompressionEpsilon)

Set the epsilon used for the recompression.

Parameters:

epsilon : float

recompression epsilon for HMatrix.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.