Mentions légales du service

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

Minor change: doc example for ConstraintList.

parent c67d1b28
Branches
Tags
No related merge requests found
...@@ -473,11 +473,16 @@ class ConstraintName: ...@@ -473,11 +473,16 @@ class ConstraintName:
class ConstraintList(object): class ConstraintList(object):
""" """
A helper class for constructing a list of consistent A helper class for constructing a list of consistent pyfaust.proj.proj_gen projectors or ConstraintGeneric objects.
matfaust.proj.proj_gen projectors or ConstraintGeneric objects.
NOTE: ConstraintGeneric use is not advised (these objects are not well NOTE: ConstraintGeneric use is not advised (these objects are not well
documented). Use rather the projectors functors (from pyfaust.proj module). documented). Use rather the projectors functors (from pyfaust.proj module).
Example:
>>> from pyfaust.factparams import ConstraintList
>>> cons = ConstraintList('splin', 5, 500, 32, 'blockdiag',[(10,10), (32,32)], 32, 32);
""" """
def __init__(self, *args): def __init__(self, *args):
# constraint definition tuple # constraint definition tuple
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment