A class representing a condition on a Constraint as to whether its sign is negative (GiNaCRA::NEGATIVE_SIGN), positive (GiNaCRA::POSITVIE_SIGN) or zero (GiNaCRA::ZERO_SIGN). More...

#include <Constraint.h>

Collaboration diagram for GiNaCRA::Constraint:

[legend]

Public Member Functions
	Constraint ()
	Standard constructor.
	Constraint (const Polynomial &p, const GiNaC::sign s, const vector< symbol > v, bool negated=false)
	Constructs a constraint represented as a sign condition `p.sgn(...) == s` or a negated sign condition `p.sgn(...) != s`.
const Polynomial	poly () const
const GiNaC::sign	sign () const
const vector< symbol >	variables () const
bool	satisfiedBy (const RealAlgebraicPoint &r) const
	Test if the given point satisfies this constraint.
Private Member Functions
const vector< symbol >	checkVariables (const Polynomial &p, const vector< symbol > &v) const throw ( invalid_argument )
	Verifies whether this constraint is solely constructed over the given variables.
Private Attributes
Polynomial	mPoly
GiNaC::sign	mSign
vector< symbol >	mVariables
bool	mNegated

Detailed Description

A class representing a condition on a Constraint as to whether its sign is negative (GiNaCRA::NEGATIVE_SIGN), positive (GiNaCRA::POSITVIE_SIGN) or zero (GiNaCRA::ZERO_SIGN).

This class is serving as an abstract superclass of both multivariate and univariate constraints.

Author:: Ulrich Loup

Since:: 2011-12-05

Version:: 2012-04-17

Definition at line 43 of file Constraint.h.

Constructor & Destructor Documentation

GiNaCRA::Constraint::Constraint ( ) [inline]

Standard constructor.

Definition at line 54 of file Constraint.h.

GiNaCRA::Constraint::Constraint	(	const Polynomial &	p,
		const GiNaC::sign	s,
		const vector< symbol >	v,
		bool	negated = `false`
	)		`[inline]`

Constructs a constraint represented as a sign condition p.sgn(...) == s or a negated sign condition p.sgn(...) != s.

Parameters:

p	polynomial compared
s	sign comparing the sign of the polynomial to GiNaCRA::ZERO_SIGN, GiNaCRA::POSITVIE_SIGN, or GiNaCRA::NEGATIVE_SIGN.
v	the variables of the polynomial
negated	if set to `true`, `satisfiedBy` checks the negation of the specified sign condition. If otherwise `false` is specified (standard value), `satisfiedBy` checks the sign condition as specified.