GCDHyperparameters#

class GCDHyperparameters(max_proj_cstrt_num=10, orthonormalize=True, opt_params=None, max_gcd_iter_num=50, gcd_iter_period=5, gcd_tol=0.01)[source]#

Bases: object

Hyperparameters for GCD algorithm.

Parameters:

max_proj_cstrt_num (int)
orthonormalize (bool)
opt_params (OptimizationHyperparameters | None)
max_gcd_iter_num (int)
gcd_iter_period (int)
gcd_tol (float)

max_proj_cstrt_num#

Maximum number of projector constraints to keep during GCD.

Type:: int

orthonormalize#

Whether to keep projector constraints orthonormalized.

Type:: bool

opt_params#

Optimization hyperparameters used for the internal dual solve at each GCD iteration. If None, GCD uses defaults suitable for frequent re-solves (notably max_restart=1).

Type:: OptimizationHyperparameters | None

max_gcd_iter_num#

Maximum number of GCD iterations.

Type:: int

gcd_iter_period#

Period for checking GCD convergence.

Type:: int

gcd_tol#

Relative tolerance for GCD convergence.

Type:: float

Attributes Summary

`gcd_iter_period`
`gcd_tol`
`max_gcd_iter_num`
`max_proj_cstrt_num`
`opt_params`
`orthonormalize`

Attributes Documentation

gcd_iter_period: int = 5#

gcd_tol: float = 0.01#

max_gcd_iter_num: int = 50#

max_proj_cstrt_num: int = 10#

opt_params: OptimizationHyperparameters | None = None#

orthonormalize: bool = True#