-  3.41.0
matfaust::factparams::ParamsHierarchicalWHTNoResCons Class Reference

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

Public Member Functions

function ParamsHierarchicalWHTNoResCons (n, varargin)
 
- Public Member Functions inherited from matfaust::factparams::ParamsHierarchicalNoResCons
function ParamsHierarchicalNoResCons (fact_constraints, stop_crit1, stop_crit2, varargin)
 Constructor. More...
 
- Public Member Functions inherited from matfaust::factparams::ParamsHierarchical
function ParamsHierarchical (fact_constraints, res_constraints, stop_crit1, stop_crit2, varargin)
 Constructor. More...
 
- Public Member Functions inherited from matfaust::factparams::ParamsFact
function ParamsFact (num_facts, constraints, varargin)
 

Static Public Member Functions

static function createParams (M, p)
 
- Static Public Member Functions inherited from matfaust::factparams::ParamsFact
static function factor_format_str2int (factor_format)
 
static function parse_opt_args (cell_args, opt_arg_names, opt_arg_map)
 
static function get_constraints (constraints)
 Returns a cell array of constraints from constraints which is a ConstraintList or cell array that can be a mix of pyfaust.factparams.ConstraintGeneric or pyfaust.proj.proj_gen. If projs is a ConstraintList then the function just returns the same object as is. More...
 

Additional Inherited Members

- Public Attributes inherited from matfaust::factparams::ParamsFact
Property step_size
 
Property constant_step_size
 
Property factor_format
 
Property packing_RL
 
Property norm2_max_iter
 
Property norm2_threshold
 
Property use_MHTP
 
Property no_normalization
 
Property no_lambda
 
- Protected Attributes inherited from matfaust::factparams::ParamsHierarchical
Constant Property DEFAULT_IS_FACT_SIDE_LEFT = false
 
- Protected Attributes inherited from matfaust::factparams::ParamsFact
Constant Property DEFAULT_STEP_SIZE = 10
 
Constant Property DEFAULT_VERBOSITY = false
 
Constant Property DEFAULT_CONSTANT_STEP_SIZE = false
 
Constant Property DEFAULT_INIT_LAMBDA = 1.0
 
Constant Property DEFAULT_IS_UPDATE_WAY_R2L = false
 
Constant Property DEFAULT_PACKING_RL = true
 
Constant Property DEFAULT_FACTOR_FORMAT = 'dynamic'
 
Constant Property DEFAULT_NO_NORMALIZATION = false
 
Constant Property DEFAULT_NO_LAMBDA = false
 
Constant Property DEFAULT_NORM2_MAX_ITER = 0
 
Constant Property DEFAULT_NORM2_THRESHOLD = 0
 
Constant Property IDX_FACTOR_FORMAT = 9
 
Constant Property IDX_PACKING_RL = 10
 
Constant Property IDX_NO_NORMALIZATION = 11
 
Constant Property IDX_NO_LAMBDA = 12
 

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 matfaust.proj.skperm.

See also matfaust.fact.hierarchical, matfaust.demo.hadamard

Constructor & Destructor Documentation

◆ ParamsHierarchicalWHTNoResCons()

function matfaust::factparams::ParamsHierarchicalWHTNoResCons::ParamsHierarchicalWHTNoResCons ( ,
varargin   
)
Parameters
nthe number of output factors (the input matrix to factorize must be of size [2^n, 2^n]) .

Example

>> import matfaust.wht
>> import matfaust.factparams.*
>> import matfaust.fact.hierarchical
>> H = full(wht(32));
>> F = hierarchical(H, p);
Faust::HierarchicalFact<FPP,DEVICE,FPP2>::compute_facts : factorization 1/4
Faust::HierarchicalFact<FPP,DEVICE,FPP2>::compute_facts : factorization 2/4
Faust::HierarchicalFact<FPP,DEVICE,FPP2>::compute_facts : factorization 3/4
Faust::HierarchicalFact<FPP,DEVICE,FPP2>::compute_facts : factorization 4/4
>>

Member Function Documentation

◆ createParams()

static function matfaust::factparams::ParamsHierarchicalWHTNoResCons::createParams ( ,
 
)
static

The documentation for this class was generated from the following file:
matfaust::wht
function wht(n, varargin)
Constructs a Faust implementing the Walsh-Hadamard Transform (WHT) of order n.
matfaust
The FAuST Matlab Wrapper
Definition: bsl.m:1
matfaust::fact
The matfaust factorization module.
Definition: butterfly.m:1
pyfaust.fact.hierarchical
def hierarchical(M, p, ret_lambda=False, ret_params=False, backend=2016, on_gpu=False)
Factorizes the matrix M using the hierarchical PALM4MSA algorithm according to the parameters set in ...
Definition: fact.py:1021
matfaust::factparams::ParamsHierarchicalWHTNoResCons::ParamsHierarchicalWHTNoResCons
function ParamsHierarchicalWHTNoResCons(n, varargin)
matfaust::factparams
The module for the parametrization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)