-  3.41.0
matfaust::factparams::ParamsHierarchicalRectMatNoResCons Class Reference

This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no constraint on the residual factors (cf. matfaust.proj.proj_id). More...

Public Member Functions

function ParamsHierarchicalRectMatNoResCons (m, n, j, k, s, varargin)
 Class constructor. More...
 
- Public Member Functions inherited from matfaust::factparams::ParamsHierarchicalRectMat
function ParamsHierarchicalRectMat (m, n, j, k, s, varargin)
 
- 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 member function to create a ParamsHierarchicalRectMatNoResCons instance by a simplified parameterization expression. More...
 
- Static Public Member Functions inherited from matfaust::factparams::ParamsHierarchicalRectMat
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::ParamsHierarchicalRectMat
Constant Property DEFAULT_RHO = 0.8
 
Constant Property DEFAULT_P_CONST_FACT = 1.4
 
- 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

This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no constraint on the residual factors (cf. matfaust.proj.proj_id).

See matfaust.fact.hierarchical

Constructor & Destructor Documentation

◆ ParamsHierarchicalRectMatNoResCons()

function matfaust::factparams::ParamsHierarchicalRectMatNoResCons::ParamsHierarchicalRectMatNoResCons ( ,
,
,
,
,
varargin   
)

Member Function Documentation

◆ createParams()

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

Static member function to create a ParamsHierarchicalRectMatNoResCons instance by a simplified parameterization expression.

Example

>> num_facts = 9;
>> k = 10;
>> s = 8;
>> p = ParamsHierarchicalRectMatNoResCons.createParams(rand(256, 1024), {'rectmat_simple', num_facts, k, s});

The documentation for this class was generated from the following file:
matfaust
The FAuST Matlab Wrapper
Definition: bsl.m:1
matfaust::factparams::ParamsHierarchicalRectMatNoResCons::ParamsHierarchicalRectMatNoResCons
function ParamsHierarchicalRectMatNoResCons(m, n, j, k, s, varargin)
Class constructor.
matfaust::factparams::ParamsHierarchicalRectMatNoResCons
This class defines the same parameterization as ParamsHierarchicalRectMat except that there is no con...
Definition: ParamsHierarchicalRectMatNoResCons.m:14
matfaust::rand
function rand(M, N, varargin)
Generates a random Faust.
matfaust::factparams
The module for the parametrization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)