-  3.39.25
pyfaust.factparams.ParamsHierarchicalWHTNoResCons Class Reference

The simplified parameterization class for factorizing a Hadamard matrix with the hierarchical factorization algorithm. More...

Public Member Functions

def __init__ (self, n)
 
- Public Member Functions inherited from pyfaust.factparams.ParamsHierarchicalNoResCons
def __init__ (self, fact_constraints, stop_crit1, stop_crit2, is_update_way_R2L=False, init_lambda=1.0, step_size=10.0 **-16, constant_step_size=False, is_fact_side_left=False, is_verbose=False, factor_format='dynamic', packing_RL=True, no_normalization=False, no_lambda=False, norm2_max_iter=100, norm2_threshold=1e-6, grad_calc_opt_mode=ParamsFact.EXTERNAL_OPT, **kwargs)
 Constructor. More...
 
- Public Member Functions inherited from pyfaust.factparams.ParamsHierarchical
def __init__ (self, fact_constraints, res_constraints, stop_crit1, stop_crit2, is_update_way_R2L=False, init_lambda=1.0, step_size=10.0 **-16, constant_step_size=False, is_fact_side_left=False, is_verbose=False, factor_format='dynamic', packing_RL=True, no_normalization=False, no_lambda=False, norm2_max_iter=100, norm2_threshold=1e-6, grad_calc_opt_mode=ParamsFact.EXTERNAL_OPT, **kwargs)
 Constructor. More...
 
def are_constraints_consistent (self, M)
 This method verifies that the constraints are shape-consistent to the matrix/array M to factorize and with each other. More...
 
def __repr__ (self)
 Returns object representation. More...
 
- Public Member Functions inherited from pyfaust.factparams.ParamsFact
def __init__ (self, num_facts, is_update_way_R2L, init_lambda, constraints, step_size, constant_step_size, is_verbose, factor_format='dynamic', packing_RL=True, no_normalization=False, no_lambda=False, norm2_max_iter=100, norm2_threshold=1e-6, grad_calc_opt_mode=EXTERNAL_OPT, **kwargs)
 

Static Public Member Functions

def createParams (M, p)
 
- Static Public Member Functions inherited from pyfaust.factparams.ParamsFact
def factor_format_str2int (factor_format)
 
def factor_format_int2str (factor_format)
 
def get_constraints (projs)
 Returns a python list of constraints from the projs which is a ConstralintList or a list/tuple that can be a mix of ConstraintGeneric or pyfaust.proj.proj_gen. More...
 

Additional Inherited Members

- Public Attributes inherited from pyfaust.factparams.ParamsFact
 step_size
 
 constant_step_size
 
 norm2_max_iter
 
 norm2_threshold
 
 factor_format
 
 packing_RL
 
 no_normalization
 
 no_lambda
 
 use_MHTP
 

Detailed Description

The simplified parameterization class for factorizing a Hadamard matrix with the hierarchical factorization algorithm.

This type of parameters is typically used for a Hadamard matrix factorization. This is a variant of ParamsHierarchicalWHT. Here the intermediate residual factors are not constrained at all, the other factors are constrained with pyfaust.proj.skperm.

See also
pyfaust.fact.hierarchical, pyfaust.demo.hadamard, ParamsHierarchicalWHTNoResCons.__init__

Constructor & Destructor Documentation

◆ __init__()

def pyfaust.factparams.ParamsHierarchicalWHTNoResCons.__init__ (   self,
  n 
)
Parameters
n(int) the number of output factors (the input matrix to factorize must be of shape (2**n, 2**n)).
proj_name(str) the type of projector used, must be either 'splincol' (default value) or 'skperm'.

Member Function Documentation

◆ createParams()

def pyfaust.factparams.ParamsHierarchicalWHTNoResCons.createParams (   M,
  p 
)
static

The documentation for this class was generated from the following file: