matfaust::factparams::ParamsFact Class Reference

The parent abstract class to represent the general factorization parameters. More...

Public Member Functions
function	ParamsFact (num_facts, constraints, varargin)

Static Public Member Functions
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
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
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 parent abstract class to represent the general factorization parameters.

See matfaust.fact.hierarchical

Constructor & Destructor Documentation

ParamsFact()

function matfaust::factparams::ParamsFact::ParamsFact	(	num_facts	,
		constraints	,
		varargin
	)

Member Function Documentation

factor_format_str2int()

static function matfaust::factparams::ParamsFact::factor_format_str2int ( factor_format  )

static

get_constraints()

static function matfaust::factparams::ParamsFact::get_constraints ( constraints  )

static

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.

The function purpose is to make the list uniform as ConstraintGeneric objects.

parse_opt_args()

static function matfaust::factparams::ParamsFact::parse_opt_args ( cell_args  , opt_arg_names  , opt_arg_map    )

static

Member Data Documentation

constant_step_size

Property matfaust::factparams::ParamsFact::constant_step_size

DEFAULT_CONSTANT_STEP_SIZE

Constant Property matfaust::factparams::ParamsFact::DEFAULT_CONSTANT_STEP_SIZE = false

protected

DEFAULT_FACTOR_FORMAT

Constant Property matfaust::factparams::ParamsFact::DEFAULT_FACTOR_FORMAT = 'dynamic'

protected

DEFAULT_INIT_LAMBDA

Constant Property matfaust::factparams::ParamsFact::DEFAULT_INIT_LAMBDA = 1.0

protected

DEFAULT_IS_UPDATE_WAY_R2L

Constant Property matfaust::factparams::ParamsFact::DEFAULT_IS_UPDATE_WAY_R2L = false

protected

DEFAULT_NO_LAMBDA

Constant Property matfaust::factparams::ParamsFact::DEFAULT_NO_LAMBDA = false

protected

DEFAULT_NO_NORMALIZATION

Constant Property matfaust::factparams::ParamsFact::DEFAULT_NO_NORMALIZATION = false

protected

DEFAULT_NORM2_MAX_ITER

Constant Property matfaust::factparams::ParamsFact::DEFAULT_NORM2_MAX_ITER = 0

protected

Note

0 means the default value defined in C++ core (100).

DEFAULT_NORM2_THRESHOLD

Constant Property matfaust::factparams::ParamsFact::DEFAULT_NORM2_THRESHOLD = 0

protected

Note

0 means the default value defined in C++ core (1e-6).

DEFAULT_PACKING_RL

Constant Property matfaust::factparams::ParamsFact::DEFAULT_PACKING_RL = true

protected

DEFAULT_STEP_SIZE

Constant Property matfaust::factparams::ParamsFact::DEFAULT_STEP_SIZE = 10

protected

DEFAULT_VERBOSITY

Constant Property matfaust::factparams::ParamsFact::DEFAULT_VERBOSITY = false

protected

factor_format

Property matfaust::factparams::ParamsFact::factor_format

IDX_FACTOR_FORMAT

Constant Property matfaust::factparams::ParamsFact::IDX_FACTOR_FORMAT = 9

protected

IDX_NO_LAMBDA

Constant Property matfaust::factparams::ParamsFact::IDX_NO_LAMBDA = 12

protected

IDX_NO_NORMALIZATION

Constant Property matfaust::factparams::ParamsFact::IDX_NO_NORMALIZATION = 11

protected

IDX_PACKING_RL

Constant Property matfaust::factparams::ParamsFact::IDX_PACKING_RL = 10

protected

no_lambda

Property matfaust::factparams::ParamsFact::no_lambda

no_normalization

Property matfaust::factparams::ParamsFact::no_normalization

norm2_max_iter

Property matfaust::factparams::ParamsFact::norm2_max_iter

norm2_threshold

Property matfaust::factparams::ParamsFact::norm2_threshold

packing_RL

Property matfaust::factparams::ParamsFact::packing_RL

step_size

Property matfaust::factparams::ParamsFact::step_size

use_MHTP

Property matfaust::factparams::ParamsFact::use_MHTP

---

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

• ParamsFact.m