parma_polyhedra_library.Generator Class Reference

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

Collaboration diagram for parma_polyhedra_library.Generator:

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

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

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

Static Private Member Functions
static native void	initIDs ()

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

Detailed Description

A line, ray, point or closure point.

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

• a line;
• a ray;
• a point;
• a closure point.

Definition at line 36 of file Generator.java.

Constructor & Destructor Documentation

parma_polyhedra_library.Generator.Generator ( Linear_Expression  e, Generator_Type  g_type  )

inlineprivate

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

Definition at line 50 of file Generator.java.

References parma_polyhedra_library.Linear_Expression.clone().

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

Member Function Documentation

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  )

inlinestatic

Returns the closure point at e / d.

Exceptions

RuntimeErrorException

Thrown if d is zero.

Definition at line 60 of file Generator.java.

References parma_polyhedra_library.Generator_Type.CLOSURE_POINT, parma_polyhedra_library.Generator.div, parma_polyhedra_library.Generator.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 125 of file Generator.java.

References parma_polyhedra_library.Generator_Type.CLOSURE_POINT, parma_polyhedra_library.Generator.div, and parma_polyhedra_library.Generator_Type.POINT.

static native void parma_polyhedra_library.Generator.initIDs ( )

staticprivate

static Generator parma_polyhedra_library.Generator.line ( Linear_Expression  e )

inlinestatic

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 78 of file Generator.java.

References parma_polyhedra_library.Generator.Generator(), and parma_polyhedra_library.Generator_Type.LINE.

Linear_Expression parma_polyhedra_library.Generator.linear_expression ( )

inline

Returns the linear expression in this.

Definition at line 116 of file Generator.java.

References parma_polyhedra_library.Generator.le.

static Generator parma_polyhedra_library.Generator.point ( Linear_Expression  e, Coefficient  d  )

inlinestatic

Returns the point at e / d.

Exceptions

RuntimeErrorException

Thrown if d is zero.

Definition at line 87 of file Generator.java.

References parma_polyhedra_library.Generator.div, parma_polyhedra_library.Generator.Generator(), parma_polyhedra_library.Coefficient.getBigInteger(), and parma_polyhedra_library.Generator_Type.POINT.

static Generator parma_polyhedra_library.Generator.ray ( Linear_Expression  e )

inlinestatic

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 106 of file Generator.java.

References parma_polyhedra_library.Generator.Generator(), and parma_polyhedra_library.Generator_Type.RAY.

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 111 of file Generator.java.

References parma_polyhedra_library.Generator.gt.

Member Data Documentation

Coefficient parma_polyhedra_library.Generator.div

private

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

Definition at line 44 of file Generator.java.

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

Generator_Type parma_polyhedra_library.Generator.gt

private

The generator type.

Definition at line 38 of file Generator.java.

Referenced by parma_polyhedra_library.Generator.type().

Linear_Expression parma_polyhedra_library.Generator.le

private

The linear expression.

Definition at line 41 of file Generator.java.

Referenced by parma_polyhedra_library.Generator.linear_expression().

---

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

• Generator.java