pyfaust.proj.proj_id Class Reference

Functor for the identity projector. More...

Public Member Functions
def	__init__ (self, shape)
Public Member Functions inherited from pyfaust.proj.proj_gen
def	__call__ (self, M)

Public Attributes
	constraint
Public Attributes inherited from pyfaust.proj.proj_gen
	shape

Detailed Description

Functor for the identity projector.

This projector simply returns the same array as the one passed as argument.

It's not useless for example in PALM4MSA (pyfaust.fact.palm4msa, pyfaust.fact.hierarchical) it might serve to avoid any constraint on a factor.

Examples

>>> from pyfaust.proj import proj_id
>>> from numpy import allclose
>>> from numpy.random import rand
>>> M = rand(5,5)
>>> p = proj_id(M.shape)
>>> allclose(p(M), M)
True

Constructor & Destructor Documentation

__init__()

def pyfaust.proj.proj_id.__init__	(		self,
			shape
	)

Parameters

shape

(tuple(int,int)) the size of the input matrix.

Reimplemented from pyfaust.proj.proj_gen.

Member Data Documentation

constraint

pyfaust.proj.proj_id.constraint

---

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

• proj.py