Constraint Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Projection operator for constraint on a ComplexField object. More...

Inheritance diagram for Constraint:

Public Member Functions
void	Apply (ComplexField field, SamplingParameters samplingParameters)
	Constraint application. This function implements a distance minimizing projection operation.
virtual void	Apply (ComplexField field, SamplingParameters samplingParameters, double projectionStrength)
	Implement variable strength projection.
	Constraint ()
	Standard constructor.
virtual double	GetDeviation (ComplexField field, SamplingParameters samplingParameters)
	Calculate quadratic deviation between original field and projected field for projection strength 1.

Public Attributes
ConstraintDomain	Domain
	Reference to the constraint domain containing this object.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Projection operator for constraint on a ComplexField object.

Member Function Documentation

Apply() [1/2]

void Apply ( ComplexField field, SamplingParameters samplingParameters )

abstract

Constraint application. This function implements a distance minimizing projection operation.

Parameters

field	Field the constraint is to be applied to.
samplingParameters	The sampling parameters of the field.

Apply() [2/2]

virtual void Apply ( ComplexField field, SamplingParameters samplingParameters, double projectionStrength )

virtual

Implement variable strength projection.

Parameters

field	Field to be transformed
samplingParameters	The sampling parameters of the field.
projectionStrength	Projection strength (0: no projection; 1: standard projection

GetDeviation()

virtual double GetDeviation ( ComplexField field, SamplingParameters samplingParameters )

virtual

Calculate quadratic deviation between original field and projected field for projection strength 1.

Parameters

field	Original field. Remains unmodified during this operation.
samplingParameters	The sampling parameters of the field.

Returns

Quadratic deviation between original field and projected field for projection strength 1