-  3.39.25
matfaust::proj::sp Class Reference

Functor for the SP projector. More...

Public Member Functions

function sp (shape, k, 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 SP projector.

Usage

    sp(shape, k): returns a SP projector (functor), shape defines the size of the input matrix (e.g. [1, 10]), k defines the sparsity of the output matrix (k nnz coefficients).
    sp(shape,k,'normalized', bool,'pos', bool): the optional parameters are set. By default both normalized and pos are false.

Parameters
shapevector of size 2, to define the size of the input matrix.
kthe sparsity parameter.
'normalized',truenormalizes the projection image according to its Frobenius norm.
'normalized',false(the default) no normalization.
'pos',trueskips the negative values (replaced by zero) of the input matrix.
'pos',false(the default) negative values are not skipped.
Return values
spprojector.

A, the image matrix, is such that \( \| A \|_0 = k, \| A\|_F = 1\) (if normalized is true).

Example

>> import matfaust.proj.sp
>> 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
>> p = sp(size(M), 3);
>> p(M)
ans =
0 0 0 0 0
0.5902 0 0.6021 0 0
0 0.5377 0 0 0
0 0 0 0 0
0 0 0 0 0
>>

Constructor & Destructor Documentation

◆ sp()

function matfaust::proj::sp::sp ( shape  ,
,
varargin   
)

The documentation for this class was generated from the following file:
matfaust::proj::sp
Functor for the SP projector.
Definition: sp.m:96
matfaust::proj
This module provides matrix projectors.
Definition: +proj/@anticirc/anticirc.m:1
matfaust
The FAuST Matlab Wrapper
Definition: bsl.m:1
matfaust::proj::sp::sp
function sp(shape, k, varargin)
matfaust::rand
function rand(M, N, varargin)
Generates a random Faust.