-  3.39.23
Public Member Functions | List of all members
matfaust::factparams::ParamsPalm4msaWHT Class Reference

This class is a simple parameterization of PALM4MSA to factorize a Hadamard matrix using the matfaust.proj.skperm proximity operator. More...

Public Member Functions

function ParamsPalm4msaWHT (matrix_size, varargin)
 Constructor. More...
 
- Public Member Functions inherited from matfaust::factparams::ParamsPalm4MSA
function ParamsPalm4MSA (constraints, stop_crit, varargin)
 Constructor. More...
 
- Public Member Functions inherited from matfaust::factparams::ParamsFact
function ParamsFact (num_facts, constraints, varargin)
 

Additional Inherited Members

- 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...
 
- 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::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 is a simple parameterization of PALM4MSA to factorize a Hadamard matrix using the matfaust.proj.skperm proximity operator.

Examples

import matfaust.fact.palm4msa
import matfaust.wht
d = 128;
H = full(wht(d));
F = palm4msa(H, p);
err = norm(full(F)-H)/norm(H) % should be about 1e-16

Reference: [1] Quoc-Tung Le, RĂ©mi Gribonval. Structured Support Exploration For Multilayer Sparse Matrix Fac- torization. ICASSP 2021 - IEEE International Conference on Acoustics, Speech and Signal Processing, Jun 2021, Toronto, Ontario, Canada. pp.1-5 hal-03132013.

See also matfaust.fact.palm4msa

Constructor & Destructor Documentation

◆ ParamsPalm4msaWHT()

function matfaust::factparams::ParamsPalm4msaWHT::ParamsPalm4msaWHT ( matrix_size  ,
varargin   
)

Constructor.


The documentation for this class was generated from the following file:
matfaust::factparams::ParamsPalm4msaWHT::ParamsPalm4msaWHT
function ParamsPalm4msaWHT(matrix_size, varargin)
Constructor.
matfaust::wht
function wht(n, varargin)
Constructs a Faust implementing the Walsh-Hadamard Transform (WHT) of order n.
pyfaust.norm
def norm(F, ord='fro', **kwargs)
Returns Faust.norm(F, ord) or numpy.linalg.norm(F, ord) depending of F type.
Definition: __init__.py:3894
matfaust
The FAuST Matlab Wrapper
Definition: bsl.m:1
pyfaust.fact.palm4msa
def palm4msa(M, p, ret_lambda=False, backend=2016, on_gpu=False)
Factorizes the matrix M with Palm4MSA algorithm using the parameters set in p.
Definition: fact.py:567
matfaust::factparams::ParamsPalm4msaWHT
This class is a simple parameterization of PALM4MSA to factorize a Hadamard matrix using the matfaust...
Definition: ParamsPalm4msaWHT.m:58
matfaust::fact
The matfaust factorization module.
Definition: butterfly.m:1
matfaust::factparams
The module for the parametrization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)