parma_polyhedra_library.Grid_Generator Class Reference

A grid line, parameter or grid point. More...

Collaboration diagram for parma_polyhedra_library.Grid_Generator:

List of all members.

Public Member Functions
Grid_Generator_Type	type ()
	Returns the generator type.
Linear_Expression	linear_expression ()
	Returns the linear expression in this.
Coefficient	divisor ()
	If this is either a grid point or a parameter, 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 Grid_Generator	grid_line (Linear_Expression e)
	Returns the line of direction e.
static Grid_Generator	parameter (Linear_Expression e, Coefficient d)
	Returns the parameter at e / d.
static Grid_Generator	grid_point (Linear_Expression e, Coefficient d)
	Returns the point at e / d.
Private Member Functions
	Grid_Generator (Linear_Expression e, Coefficient d, Grid_Generator_Type generator_type)
Static Private Member Functions
static native void	initIDs ()
Private Attributes
Grid_Generator_Type	gt
	The grid generator type.
Linear_Expression	le
	The linear expression.
Coefficient	div
	The coefficient used if the grid generator is a parameter or a grid point a parameter.

---

Detailed Description

A grid line, parameter or grid point.

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

• a grid_line;
• a parameter;
• a grid_point.

Definition at line 37 of file Grid_Generator.java.

---

Constructor & Destructor Documentation

parma_polyhedra_library.Grid_Generator.Grid_Generator ( Linear_Expression  e, Coefficient  d, Grid_Generator_Type  generator_type  )

inlineprivate

Definition at line 51 of file Grid_Generator.java.

References parma_polyhedra_library.Linear_Expression.clone(), parma_polyhedra_library.Grid_Generator.div, parma_polyhedra_library.Grid_Generator.gt, and parma_polyhedra_library.Grid_Generator.le.

Referenced by parma_polyhedra_library.Grid_Generator.grid_line(), parma_polyhedra_library.Grid_Generator.grid_point(), and parma_polyhedra_library.Grid_Generator.parameter().

---

Member Function Documentation

native String parma_polyhedra_library.Grid_Generator.ascii_dump

(

)

Returns an ascii formatted internal representation of this.

Coefficient parma_polyhedra_library.Grid_Generator.divisor ( )

inline

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

Exceptions:

RuntimeErrorException

Thrown if this is a line.

Definition at line 104 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.div, parma_polyhedra_library.Grid_Generator.gt, and parma_polyhedra_library.Grid_Generator_Type.LINE.

static Grid_Generator parma_polyhedra_library.Grid_Generator.grid_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 64 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.Grid_Generator(), and parma_polyhedra_library.Grid_Generator_Type.LINE.

static Grid_Generator parma_polyhedra_library.Grid_Generator.grid_point ( Linear_Expression  e, Coefficient  d  )

inlinestatic

Returns the point at e / d.

Exceptions:

RuntimeErrorException

Thrown if d is zero.

Definition at line 84 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.Grid_Generator(), and parma_polyhedra_library.Grid_Generator_Type.POINT.

static native void parma_polyhedra_library.Grid_Generator.initIDs ( )

staticprivate

Linear_Expression parma_polyhedra_library.Grid_Generator.linear_expression ( )

inline

Returns the linear expression in this.

Definition at line 95 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.le.

static Grid_Generator parma_polyhedra_library.Grid_Generator.parameter ( Linear_Expression  e, Coefficient  d  )

inlinestatic

Returns the parameter at e / d.

Exceptions:

RuntimeErrorException

Thrown if d is zero.

Definition at line 74 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.Grid_Generator(), and parma_polyhedra_library.Grid_Generator_Type.PARAMETER.

native String parma_polyhedra_library.Grid_Generator.toString

(

)

Returns a string representation of this.

Grid_Generator_Type parma_polyhedra_library.Grid_Generator.type ( )

inline

Returns the generator type.

Definition at line 90 of file Grid_Generator.java.

References parma_polyhedra_library.Grid_Generator.gt.

---

Member Data Documentation

Coefficient parma_polyhedra_library.Grid_Generator.div

private

The coefficient used if the grid generator is a parameter or a grid point a parameter.

Definition at line 49 of file Grid_Generator.java.

Referenced by parma_polyhedra_library.Grid_Generator.divisor(), and parma_polyhedra_library.Grid_Generator.Grid_Generator().

Grid_Generator_Type parma_polyhedra_library.Grid_Generator.gt

private

The grid generator type.

Definition at line 40 of file Grid_Generator.java.

Referenced by parma_polyhedra_library.Grid_Generator.divisor(), parma_polyhedra_library.Grid_Generator.Grid_Generator(), and parma_polyhedra_library.Grid_Generator.type().

Linear_Expression parma_polyhedra_library.Grid_Generator.le

private

The linear expression.

Definition at line 43 of file Grid_Generator.java.

Referenced by parma_polyhedra_library.Grid_Generator.Grid_Generator(), and parma_polyhedra_library.Grid_Generator.linear_expression().

---

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

• Grid_Generator.java