-  3.39.23
Public Member Functions | List of all members
matfaust::proj::skperm Class Reference

Functor for the SKPERM projector. More...

Public Member Functions

function skperm (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 SKPERM projector.

This projector returns the matrix with k nonzeros of the input matrix per column and per row that maximizes the Frobenius norm.

Usage

    skperm(shape, k): returns a SKPERM 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 per row or per column).
    splincol(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',true(the default) normalizes the projection image according to its Frobenius norm.
'normalized',falseno normalization.
'pos',trueskips the negative values (replaced by zero) of the input matrix.
'pos',false(the default) negative values are not skipped.
Return values
projthe skperm projector.

Example

>> import matfaust.proj.*
>> 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 = skperm(size(M), 3, 'normalized', false);
>> p(M)
ans =
0 0 0.0206 0.1834 0.6119
0.9507 0 0.9699 0.3042 0
0.7320 0.8662 0.8324 0 0
0.5987 0.6011 0 0 0.3664
0 0.7081 0 0.2912 0.4561
>>

Constructor & Destructor Documentation

◆ skperm()

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

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