-
3.39.21
|
This class defines the names for the sub-types of constraints into the ConstraintGeneric hierarchy of classes. More...
Public Member Functions | |
def | __init__ (self, name) |
Constructor of the ConstraintName object. More... | |
def | is_int_constraint (self) |
A delegate for ConstraintGeneric.is_int_constraint. More... | |
def | is_real_constraint (self) |
A delegate for ConstraintGeneric.is_real_constraint. More... | |
def | is_mat_constraint (self) |
A delegate for ConstraintGeneric.is_mat_constraint. More... | |
def | name_str (self) |
Returns the str constant name of this constraint. More... | |
Static Public Member Functions | |
def | name_int2str (_id) |
Converts a int constraint short name to its str constant name equivalent. More... | |
def | str2name_int (_str) |
Converts a str constraint short name to its integer constant name equivalent. More... | |
Public Attributes | |
name | |
Static Public Attributes | |
int | SP = 0 |
int | SPCOL = 1 |
int | SPLIN = 2 |
int | NORMCOL = 3 |
int | SPLINCOL = 4 |
int | CONST = 5 |
int | SP_POS = 6 |
int | BLKDIAG = 7 |
int | SUPP = 8 |
int | NORMLIN = 9 |
int | TOEPLITZ = 10 |
int | CIRC = 11 |
int | ANTICIRC = 12 |
int | HANKEL = 13 |
int | SKPERM = 14 |
int | ID = 15 |
int | SPTRIU = 16 |
int | SPTRIL = 17 |
int | SPSYMM = 18 |
This class defines the names for the sub-types of constraints into the ConstraintGeneric hierarchy of classes.
The table here is a summary of the available constraints.
Examples
def pyfaust.factparams.ConstraintName.__init__ | ( | self, | |
name | |||
) |
Constructor of the ConstraintName object.
name | must be a valid constraint name (integer among the static constants defined in the class: ConstraintName.SP, ...). |
def pyfaust.factparams.ConstraintName.is_int_constraint | ( | self | ) |
A delegate for ConstraintGeneric.is_int_constraint.
def pyfaust.factparams.ConstraintName.is_mat_constraint | ( | self | ) |
A delegate for ConstraintGeneric.is_mat_constraint.
def pyfaust.factparams.ConstraintName.is_real_constraint | ( | self | ) |
A delegate for ConstraintGeneric.is_real_constraint.
|
static |
Converts a int constraint short name to its str constant name equivalent.
For example, name_int2str(ConstraintName.SP) returns 'sp'.
def pyfaust.factparams.ConstraintName.name_str | ( | self | ) |
Returns the str constant name of this constraint.
|
static |
Converts a str constraint short name to its integer constant name equivalent.
For example, str2name_int('sp') returns ConstraintName.SP.
|
static |
Designates a constraint to produce an anti-circulant matrix (cf. pyfaust.proj.anticirc).
|
static |
Designates a constraint to produce a block-diagonal matrix (cf. pyfaust.proj.blockdiag).
|
static |
Designates a constraint to produce a circulant matrix (cf. pyfaust.proj.circ).
|
static |
Designates a constraint imposing to a matrix to be constant.
|
static |
Designates a constraint to produce an anti-circulant matrix (cf. pyfaust.proj.hankel).
|
static |
Identity prox/constraint.
pyfaust.factparams.ConstraintName.name |
The name of the constraint (actually an integer among the valid constants).
|
static |
Designates a 2-norm constraint on each column of a matrix.
|
static |
Designates a 2-norm constraint on each row of a matrix.
|
static |
SKPERM prox/constraint.
|
static |
Designates a constraint on the sparsity/0-norm of a matrix.
|
static |
Designates a constraint that imposes a SP constraints and besides set to zero the negative coefficients (it doesn't apply to complex matrices).
|
static |
Designates a sparsity/0-norm constraint on the columns of a matrix.
|
static |
Designates a sparsity/0-norm constraint on the rows of a matrix.
|
static |
Designates a constraint that imposes both SPLIN and SPCOL constraints (see example above for clarification).
|
static |
Designates a constraint on the sparsity/0-norm of a symmetric matrix.
|
static |
Designates a constraint on the sparsity/0-norm of lower triangular part of a matrix.
|
static |
Designates a constraint on the sparsity/0-norm of upper triangular part of a matrix.
|
static |
Designates a constraint by a support matrix S (element-wisely multiplying the matrix to constrain to obtain a matrix for which the 2-norm equals 1, see: ConstraintMat.project()).
|
static |
Designates a constraint to produce a toeplitz matrix (cf. pyfaust.proj.toeplitz).