Mentions légales du service

Skip to content
Snippets Groups Projects
Commit ff5b009d authored by hhakim's avatar hhakim
Browse files

Missing matfaust files for projectors added in a65434aa.

parent 3e3fc098
No related branches found
No related tags found
No related merge requests found
Pipeline #833804 skipped
%==================================================
%> @brief Functor for the CIRC projector.
%>
%> The output matrix of the projector is a circulant matrix.
%>
%> Each constant used to fill a pair of diagonals of the output matrix is the mean of all the input matrix entries that it replaces in the output matrix.
%==================================================
classdef circ < matfaust.proj.proj_gen
properties
end
methods
%===============================================
%> @brief The circulant projector.
%>
%> @b Usage
%>
%> &nbsp;&nbsp;&nbsp; @b circ(shape): returns a CIRC projector (functor), shape defines the size of the input matrix (e.g. [1, 10]).<br/>
%> &nbsp;&nbsp;&nbsp; @b circ(@b shape,@b 'normalized', bool,@b 'pos', bool): the optional parameters are set. By default both normalized and pos are false.
%>
%> @param 'normalized', true: normalizes the projection image according to its Frobenius norm.
%> @param 'normalized', false: (the default) no normalization.
%> @param 'pos', true: skips the negative values (replaced by zero) of the input matrix.
%> @param 'pos', false: (the default) negative values are not skipped.
%>
%> @retval the circ projector.
%===============================================
function proj = circ(shape, varargin)
import matfaust.factparams.ConstraintMat
proj.constraint = ConstraintMat('circ', shape, varargin{:});
end
end
end
%==================================================
%> @brief Functor for the HANKEL projector.
%>
%> Each antidiagonal of the projector output matrix is filled with a constant value which is the mean of the elements in the same antidiagonal of the input matrix.
%==================================================
classdef hankel < matfaust.proj.proj_gen
properties
end
methods
%===============================================
%> @brief the Hankel projector.
%>
%> @b Usage
%>
%> &nbsp;&nbsp;&nbsp; @b hankel(shape): returns a HANKEL projector (functor), shape defines the size of the input matrix (e.g. [1, 10]).<br/>
%> &nbsp;&nbsp;&nbsp; @b hankel(@b shape,@b 'normalized', bool,@b 'pos', bool): the optional parameters are set. By default both normalized and pos are false.
%>
%> @param 'normalized', true: normalizes the projection image according to its Frobenius norm.
%> @param 'normalized', false: (the default) no normalization.
%> @param 'pos', true: skips the negative values (replaced by zero) of the input matrix.
%> @param 'pos', false: (the default) negative values are not skipped.
%> @retval the hankel projector.
%===============================================
function proj = hankel(shape, varargin)
import matfaust.factparams.ConstraintMat
proj.constraint = ConstraintMat('hankel', shape, varargin{:});
end
end
end
%==================================================
%> @brief Functor for the TOEPLITZ projector.
%>
%> Each diagonal of the projector output matrix is filled with a constant value which is the mean of the elements in the same diagonal of the input matrix.
%==================================================
classdef toeplitz < matfaust.proj.proj_gen
properties
end
methods
%===============================================
%> @brief The toeplitz projector.
%>
%> @b Usage
%>
%> &nbsp;&nbsp;&nbsp; @b toeplitz(shape): returns a TOEPLITZ projector (functor), shape defines the size of the input matrix (e.g. [1, 10]).<br/>
%> &nbsp;&nbsp;&nbsp; @b toeplitz(@b shape,@b 'normalized', bool,@b 'pos', bool): the optional parameters are set. By default both normalized and pos are false.
%>
%> @param 'normalized', true: normalizes the projection image according to its Frobenius norm.
%> @param 'normalized', false: (the default) no normalization.
%> @param 'pos', true: skips the negative values (replaced by zero) of the input matrix.
%> @param 'pos', false: (the default) negative values are not skipped.
%> @retval proj the toeplitz projector.
%===============================================
function proj = toeplitz(S, varargin)
import matfaust.factparams.ConstraintMat
proj.constraint = ConstraintMat('toeplitz', S, varargin{:});
end
end
end
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment