HMatrixParameters

class HMatrixParameters(*args)

Parameters for HMatrix class.

Notes

This class regroups the parameters used by HMatrix

Methods

getAdmissibilityFactor(self)

Return the admissibility factor used for cluster blocks.

getAssemblyEpsilon(self)

Return the epsilon used for the assembly.

getClassName(self)

Accessor to the object’s name.

getClusteringAlgorithm(self)

Return the clustering algorithm.

getCompressionMethod(self)

Return the compression method.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getRecompressionEpsilon(self)

Return the epsilon used for the recompression.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setAdmissibilityFactor(self, admissibilityFactor)

Set the admissibility factor used for cluster blocks.

setAssemblyEpsilon(self, assemblyEpsilon)

Set the epsilon used for the assembly.

setClusteringAlgorithm(self, clusteringAlgorithm)

Set the clustering algorithm.

setCompressionMethod(self, compressionMethod)

Set the compression method.

setName(self, name)

Accessor to the object’s name.

setRecompressionEpsilon(self, …)

Set the epsilon used for the recompression.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

__init__(self, *args)

Initialize self. See help(type(self)) for accurate signature.

getAdmissibilityFactor(self)

Return the admissibility factor used for cluster blocks.

Returns
epsilonfloat

admissibility factor for HMatrix.

getAssemblyEpsilon(self)

Return the epsilon used for the assembly.

Returns
epsilonfloat

assembly epsilon for HMatrix.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

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

getClusteringAlgorithm(self)

Return the clustering algorithm.

Returns
algorithmstr

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

getCompressionMethod(self)

Return the compression method.

Returns
methodstr

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

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getRecompressionEpsilon(self)

Return the epsilon used for the recompression.

Returns
epsilonfloat

recompression epsilon for HMatrix.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

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

setAdmissibilityFactor(self, admissibilityFactor)

Set the admissibility factor used for cluster blocks.

Parameters
epsilonfloat

admissibility factor for HMatrix.

setAssemblyEpsilon(self, assemblyEpsilon)

Set the epsilon used for the assembly.

Parameters
epsilonfloat

assembly epsilon for HMatrix.

setClusteringAlgorithm(self, clusteringAlgorithm)

Set the clustering algorithm.

Parameters
algorithmstr

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

setCompressionMethod(self, compressionMethod)

Set the compression method.

Parameters
methodstr

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

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setRecompressionEpsilon(self, recompressionEpsilon)

Set the epsilon used for the recompression.

Parameters
epsilonfloat

recompression epsilon for HMatrix.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.