coco::semantics Class Reference
[Module Base Classes]

Expression Semantics. More...

#include <semantics.h>

Collaboration diagram for coco::semantics:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 semantics ()
 semantics (const semantics &__s)
 ~semantics ()
void read (char *c)
void merge (const semantics &__s)
Access and Storage Methods
These methods are for access and storage of all those flags that are not automatically stored by the simplifier.

const convex_econvexity () const
void convexity (const convex_e &__c)
const tristateseparability () const
void separability (const tristate &__c)
const activity_descractivity () const
void activity (const activity_descr &__c)
bool kj_flag () const
void kj_flag (bool __c)
bool integer_flag () const
void integer_flag (bool __c)
bool hard_flag () const
void hard_flag (bool __c)
bool is_at_either_bound () const
void is_at_either_bound (bool __c)
const type_annotationtype () const
void type (const type_annotation &__c)
bool redundancy () const
bool inactive_hi () const
bool inactive_lo () const
bool inactive () const

Public Attributes

struct {
   convex_e   c_info
   activity_descr   act
   tristate   separable
   bool   is_at_either_bound
property_flags
struct {
   bool   kj
   bool   integer
   type_annotation   type
   bool   hard
annotation_flags
struct {
   tristate   has_0chnbase
info_flags
unsigned int _0chnbase
int addinfo
int degree
int dim
int stage

Friends

std::ostream & operator<< (std::ostream &o, const semantics &__s)
 C++ stream output operator for semantics.


Detailed Description

This class is used to describe additional semantics information associated to an expression_node in the expression DAG.

Definition at line 271 of file semantics.h.


Constructor & Destructor Documentation

coco::semantics::semantics (  )  [inline]

Standard Constructor

Definition at line 441 of file semantics.h.

coco::semantics::semantics ( const semantics __s  )  [inline]

Standard Copy Constructor

Definition at line 318 of file semantics.h.

coco::semantics::~semantics (  )  [inline]

Standard Destructor

Definition at line 326 of file semantics.h.


Member Function Documentation

void coco::semantics::activity ( const activity_descr __c  )  [inline]

This is the storage method for the activity description in the property_flags structure.

Definition at line 387 of file semantics.h.

const activity_descr& coco::semantics::activity (  )  const [inline]

This is the accessor for the activity description in the property_flags structure.

Definition at line 384 of file semantics.h.

void coco::semantics::convexity ( const convex_e __c  )  [inline]

This is the storage method for the convex_e specifier in the property_flags structure.

Definition at line 373 of file semantics.h.

const convex_e& coco::semantics::convexity (  )  const [inline]

This is the accessor for the convex_e specifier in the property_flags structure.

Definition at line 370 of file semantics.h.

void coco::semantics::hard_flag ( bool  __c  )  [inline]

This is the storage method for the hard (constraint) flag in the annotation_flags structure.

Definition at line 408 of file semantics.h.

bool coco::semantics::hard_flag (  )  const [inline]

This is the accessor for the hard (constraint) flag in the annotation_flags structure.

Definition at line 405 of file semantics.h.

bool coco::semantics::inactive (  )  const [inline]

This method returns whether the constraint is known to be inactive.

Definition at line 436 of file semantics.h.

bool coco::semantics::inactive_hi (  )  const [inline]

This method returns whether the constraint is known to be inactive at the upper bound.

Definition at line 429 of file semantics.h.

bool coco::semantics::inactive_lo (  )  const [inline]

This method returns whether the constraint is known to be inactive at the lower bound.

Definition at line 433 of file semantics.h.

void coco::semantics::integer_flag ( bool  __c  )  [inline]

This is the storage method for the integer flag in the annotation_flags structure.

Definition at line 401 of file semantics.h.

bool coco::semantics::integer_flag (  )  const [inline]

This is the accessor for the integer flag in the annotation_flags structure.

Definition at line 398 of file semantics.h.

void coco::semantics::is_at_either_bound ( bool  __c  )  [inline]

This is the storage method for the is_at_either_bound flag in the property_flags structure.

Definition at line 415 of file semantics.h.

bool coco::semantics::is_at_either_bound (  )  const [inline]

This is the accessor for the is_at_either_bound flag in the property_flags structure.

Definition at line 412 of file semantics.h.

void coco::semantics::kj_flag ( bool  __c  )  [inline]

This is the storage method for the KJ flag in the annotation_flags structure.

Definition at line 394 of file semantics.h.

bool coco::semantics::kj_flag (  )  const [inline]

This is the accessor for the KJ flag in the annotation_flags structure.

Definition at line 391 of file semantics.h.

void coco::semantics::merge ( const semantics __s  )  [inline]

This method merges this semantics structure with the structure __s.

Definition at line 500 of file semantics.h.

void coco::semantics::read ( char *  c  ) 

A call to this method reads a semantics structure from the C string c (.dag format).

Definition at line 156 of file semantics.cc.

bool coco::semantics::redundancy (  )  const [inline]

This method returns whether the constraint is known to be redundant.

Definition at line 425 of file semantics.h.

void coco::semantics::separability ( const tristate __c  )  [inline]

This is the storage method for the seperable entry in the property_flags structure.

Definition at line 380 of file semantics.h.

const tristate& coco::semantics::separability (  )  const [inline]

This is the accessor for the seperable entry in the property_flags structure.

Definition at line 377 of file semantics.h.

void coco::semantics::type ( const type_annotation __c  )  [inline]

This is the storage method for the type specifier in the annotation_flags structure.

Definition at line 422 of file semantics.h.

const type_annotation& coco::semantics::type (  )  const [inline]

This is the accessor for the type specifier in the annotation_flags structure.

Definition at line 419 of file semantics.h.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const semantics __s 
) [friend]

This operator writes a semantics expression in .dag format to an ostream.

Definition at line 251 of file semantics.cc.


Member Data Documentation

This member specifies the node number of the base of the 0-chain (univariate subgraph) leading to this node.

Definition at line 298 of file semantics.h.

The activity information for constraints

Definition at line 277 of file semantics.h.

for KJ variables this numbe is the corresponding constraint number, -1 if kappa (for objective)

Definition at line 302 of file semantics.h.

The annotation_flags describe model specific properties

The convexity structure for any node

Definition at line 276 of file semantics.h.

This member holds the polynomial degree of the expression this node represents, and it is -1 in case of a non-polynomial non-linearity

Definition at line 306 of file semantics.h.

The dim member stores the number of variables involved in that expression (the apparent dimension).

Definition at line 309 of file semantics.h.

a hard or soft constraint?

Definition at line 288 of file semantics.h.

node has a 0-chain base?

Definition at line 293 of file semantics.h.

The info_flags describe algorithmic properties

integer (not real) value?

Definition at line 286 of file semantics.h.

Whether a constraint is known to be on either bound (unknown on which)

Definition at line 279 of file semantics.h.

from KJ conditions?

Definition at line 285 of file semantics.h.

The property_flags describe mathematical constraint properties

The seperability information for any node.

Definition at line 278 of file semantics.h.

This describes the stage to which this node belongs in a multistage problem.

Definition at line 312 of file semantics.h.

a exists, forall, free, stochastic type

Definition at line 287 of file semantics.h.


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

Generated on Tue Feb 9 14:50:00 2010 for COCONUT API by  doxygen 1.5.8