matfaust::proj::supp Class Reference

Functor for the the SUPP projector. More...

Public Member Functions
function	supp (S, varargin)
Public Member Functions inherited from matfaust::proj::proj_gen
function	subsref (self, S)

Additional Inherited Members
Protected Attributes inherited from matfaust::proj::proj_gen
Property	constraint

Detailed Description

Functor for the the SUPP projector.

A, the image matrix, is such that nonzeros(A) == nonzeros(S)

Usage

    supp(S): returns a SUPP projector (functor), S defines the support matrix (entries are 0 or 1) for which the nonzeros entries define the values to keep from the input matrix into the ouput matrix of the projector.
    supp(S,'normalized', bool,'pos', bool): the optional parameters are set. By default both normalized and pos are false.

Parameters

'normalized',true	normalizes the projection image according to its Frobenius norm.
'normalized',false	(the default) no normalization.
'pos',true	skips the negative values (replaced by zero) of the input matrix.
'pos',false	(the default) negative values are not skipped.

Return values

proj	the supp projector.

Example

>> import matfaust.proj.supp
>> rng(42)
>> M = rand(5, 5)
 
M =
 
    0.3745    0.1560    0.0206    0.1834    0.6119
    0.9507    0.0581    0.9699    0.3042    0.1395
    0.7320    0.8662    0.8324    0.5248    0.2921
    0.5987    0.6011    0.2123    0.4319    0.3664
    0.1560    0.7081    0.1818    0.2912    0.4561
 
>> S = zeros(5, 5);
>> S(M > .5) = 1; % the support of values > .5 in M
>> p = supp(S, 'normalized', false);
>> p(M)
 
ans =
 
         0         0         0         0    0.6119
    0.9507         0    0.9699         0         0
    0.7320    0.8662    0.8324    0.5248         0
    0.5987    0.6011         0         0         0
         0    0.7081         0         0         0
>>

Constructor & Destructor Documentation

supp()

function matfaust::proj::supp::supp	(	S	,
		varargin
	)

---

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

• supp.m