KLUControl

class sksparse.klu.KLUControl[source]

A dataclass to set KLU control parameters.

tol[source]

The pivot tolerance. Default is None, which uses the KLU default of 0.001.

Type:

float

memgrow[source]

The memory growth factor. Default is None, which uses the KLU default of 1.2.

Type:

float

initmem_amd[source]

The initial memory allocation factor for AMD. Default is None, which uses the KLU default of 1.2.

Type:

float

initmem[source]

The initial memory allocation factor for the numeric factorization. Default is None, which uses the KLU default of 10.

Type:

float

maxwork[source]

The maximum work done by BTF. Default is None, which uses the KLU default of 0, or unlimited.

Type:

float

btf[source]

Whether to use BTF pre-ordering. Default is None, which uses the KLU default of True.

Type:

bool

ordering[source]

The fill-reducing ordering. Accepted values are:

  • AMD: Approximate Minimum Degree ordering.

  • COLAMD : Column Approximate Minimum Degree ordering.

  • user_perm: User-provided ordering (not yet supported).

  • user_func: User-defined ordering function (not yet supported).

Default is None, which uses the KLU default setting of AMD.

Type:

str

scale[source]

The row-scaling method. Accepted values are:

  • none_no_check

  • none

  • sum

  • max

Default is None, which uses the KLU default setting of max.

Type:

str

Added in version 0.5.0.

Methods