Constraint Class Reference

Public Member Functions
	__init__ (self, comment="", value=0.)
	add (self, label, coeff)
	get_checksum (self)

Public Attributes
	value = value
	Value.
	comment = comment
	Comment.
list	data = []
	Data.

Detailed Description

Class representing a linear constraint for global parameters

Definition at line 16 of file constraints.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			comment = "",
			value = 0. )

Initialize constraint

comment : str
  TODO: Not yet used
value : float
  The constant term of the constraint: sum(c_i * par_i) = value

Definition at line 21 of file constraints.py.

    def __init__(self, comment="", value=0.):
        """
        Initialize constraint
 
        comment : str
          TODO: Not yet used
        value : float
          The constant term of the constraint: sum(c_i * par_i) = value
        """
        
        self.value = value
        
        self.comment = comment
        
        self.data = []
 

Member Function Documentation

add()

add	(		self,
			label,
			coeff )

Add coefficient for a global parameter

Parameters
----------
label : int
  global parameter id (GlobalLabel::label())
coeff : float
  coefficient of the parameter in constraint

Definition at line 37 of file constraints.py.

    def add(self, label, coeff):
        """
        Add coefficient for a global parameter
 
        Parameters
        ----------
        label : int
          global parameter id (GlobalLabel::label())
        coeff : float
          coefficient of the parameter in constraint
        """
        entry = (label, coeff)
        self.data.append(entry)
 

get_checksum()

get_checksum

(

self

)

Get a checksum to distinguish constraints quickly (computed only from labels)

Definition at line 51 of file constraints.py.

    def get_checksum(self):
        """Get a checksum to distinguish constraints quickly (computed only from labels)
        """
        labels_only = [label for (label, coeff) in self.data]
        checksum = hash(str(labels_only))
        return checksum
 
 

Member Data Documentation

comment

comment = comment

Comment.

Definition at line 33 of file constraints.py.

data

list data = []

Data.

Definition at line 35 of file constraints.py.

value

value = value

Value.

Definition at line 31 of file constraints.py.

---

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

• alignment/scripts/alignment/constraints.py