parma_polyhedra_library::Generator Class Reference
[Java Language Interface]

A line, ray, point or closure point. More...

Collaboration diagram for parma_polyhedra_library::Generator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Generator_Type type ()
 Returns the generator type.
Linear_Expression linear_expression ()
 Returns the linear expression in this.
Coefficient divisor ()
 If this is either a point or a closure point, returns its divisor.
native String ascii_dump ()
 Returns an ascii formatted internal representation of this.
native String toString ()
 Returns a string representation of this.

Static Public Member Functions

static Generator closure_point (Linear_Expression e, Coefficient d)
 Returns the closure point at e / d.
static Generator line (Linear_Expression e)
 Returns the line of direction e.
static Generator point (Linear_Expression e, Coefficient d)
 Returns the point at e / d.
static Generator ray (Linear_Expression e)
 Returns the ray of direction e.

Static Package Functions

 [static initializer]

Private Member Functions

 Generator (Linear_Expression e, Generator_Type g_type)
 Builds a generator of type g_type, stealing the coefficients from e.

Static Private Member Functions

static native void initIDs ()

Private Attributes

Generator_Type gt
 The generator type.
Linear_Expression le
 The linear expression.
Coefficient div
 The divisor (valid if the generator is a point or a closure point).

Detailed Description

A line, ray, point or closure point.

An object of the class Generator is one of the following:

Definition at line 40 of file Generator.java.


Constructor & Destructor Documentation

parma_polyhedra_library::Generator::Generator ( Linear_Expression  e,
Generator_Type  g_type 
) [inline, private]

Builds a generator of type g_type, stealing the coefficients from e.

Definition at line 54 of file Generator.java.

References parma_polyhedra_library::Linear_Expression::clone(), gt, and le.

Referenced by closure_point(), line(), point(), and ray().


Member Function Documentation

parma_polyhedra_library::Generator::[static initializer] (  )  [inline, static, package]
native String parma_polyhedra_library::Generator::ascii_dump (  ) 

Returns an ascii formatted internal representation of this.

static Generator parma_polyhedra_library::Generator::closure_point ( Linear_Expression  e,
Coefficient  d 
) [inline, static]

Returns the closure point at e / d.

Exceptions:
RuntimeErrorException Thrown if d is zero.

Definition at line 64 of file Generator.java.

References div, Generator(), and parma_polyhedra_library::Coefficient::getBigInteger().

Coefficient parma_polyhedra_library::Generator::divisor (  )  [inline]

If this is either a point or a closure point, returns its divisor.

Exceptions:
RuntimeErrorException Thrown if this is neither a point nor a closure point.

Definition at line 129 of file Generator.java.

References div, and gt.

static native void parma_polyhedra_library::Generator::initIDs (  )  [static, private]
static Generator parma_polyhedra_library::Generator::line ( Linear_Expression  e  )  [inline, static]

Returns the line of direction e.

Exceptions:
RuntimeErrorException Thrown if the homogeneous part of e represents the origin of the vector space.

Definition at line 82 of file Generator.java.

References Generator().

Linear_Expression parma_polyhedra_library::Generator::linear_expression (  )  [inline]

Returns the linear expression in this.

Definition at line 120 of file Generator.java.

References le.

static Generator parma_polyhedra_library::Generator::point ( Linear_Expression  e,
Coefficient  d 
) [inline, static]

Returns the point at e / d.

Exceptions:
RuntimeErrorException Thrown if d is zero.

Definition at line 91 of file Generator.java.

References div, Generator(), and parma_polyhedra_library::Coefficient::getBigInteger().

static Generator parma_polyhedra_library::Generator::ray ( Linear_Expression  e  )  [inline, static]

Returns the ray of direction e.

Exceptions:
RuntimeErrorException Thrown if the homogeneous part of e represents the origin of the vector space.

Definition at line 110 of file Generator.java.

References Generator().

native String parma_polyhedra_library::Generator::toString (  ) 

Returns a string representation of this.

Generator_Type parma_polyhedra_library::Generator::type (  )  [inline]

Returns the generator type.

Definition at line 115 of file Generator.java.

References gt.


Member Data Documentation

The divisor (valid if the generator is a point or a closure point).

Definition at line 48 of file Generator.java.

Referenced by closure_point(), divisor(), and point().

The generator type.

Definition at line 42 of file Generator.java.

Referenced by divisor(), Generator(), and type().

The linear expression.

Definition at line 45 of file Generator.java.

Referenced by Generator(), and linear_expression().


The documentation for this class was generated from the following file:
Generated on Sun Feb 27 16:23:05 2011 for PPL Java Language Interface by  doxygen 1.6.3