PPL  1.2
Public Member Functions | Static Private Attributes | Friends | List of all members
Parma_Polyhedra_Library::Init Class Reference
C++ Language Interface

Class for initialization and finalization. More...

#include <Init_defs.hh>

Public Member Functions

 Init ()
 Initializes the PPL. More...
 
 ~Init ()
 Finalizes the PPL. More...
 

Static Private Attributes

static const unsigned DEFAULT_IRRATIONAL_PRECISION = 128U
 Default precision parameter used for irrational calculations. More...
 
static unsigned int count = 0
 Count the number of objects created. More...
 
static fpu_rounding_direction_type old_rounding_direction
 

Friends

void set_rounding_for_PPL ()
 Sets the FPU rounding mode so that the PPL abstractions based on floating point numbers work correctly. More...
 
void restore_pre_PPL_rounding ()
 Sets the FPU rounding mode as it was before initialization of the PPL. More...
 

Detailed Description

Class for initialization and finalization.

Nifty Counter initialization class, ensuring that the library is initialized only once and before its first use. A count of the number of translation units using the library is maintained. A static object of Init type will be declared by each translation unit using the library. As a result, only one of them will initialize and properly finalize the library.

Definition at line 72 of file Init_defs.hh.

Constructor & Destructor Documentation

Parma_Polyhedra_Library::Init::Init ( )

Initializes the PPL.

Definition at line 133 of file Init.cc.

References Parma_Polyhedra_Library::Coefficient_constants_initialize(), count, DEFAULT_IRRATIONAL_PRECISION, Parma_Polyhedra_Library::Variable::default_output_function(), Parma_Polyhedra_Library::fpu_get_rounding_direction(), Parma_Polyhedra_Library::fpu_initialize_control_functions(), Parma_Polyhedra_Library::fpu_set_rounding_direction(), Parma_Polyhedra_Library::initialize(), Parma_Polyhedra_Library::Constraint_System::initialize(), Parma_Polyhedra_Library::Congruence_System::initialize(), Parma_Polyhedra_Library::Grid_Generator_System::initialize(), Parma_Polyhedra_Library::Generator_System::initialize(), Parma_Polyhedra_Library::Congruence::initialize(), Parma_Polyhedra_Library::Polyhedron::initialize(), Parma_Polyhedra_Library::Constraint::initialize(), Parma_Polyhedra_Library::Grid_Generator::initialize(), Parma_Polyhedra_Library::Generator::initialize(), Parma_Polyhedra_Library::Linear_Expression::initialize(), old_rounding_direction, ppl_set_GMP_memory_allocation_functions(), Parma_Polyhedra_Library::ROUND_DIRECT, Parma_Polyhedra_Library::round_fpu_dir(), Parma_Polyhedra_Library::set_irrational_precision(), and Parma_Polyhedra_Library::Variable::set_output_function().

133  {
134  // Only when the first Init object is constructed...
135  if (count++ == 0) {
136  // ... the GMP memory allocation functions are set, ...
137  ppl_set_GMP_memory_allocation_functions();
138  // ... the default output function for Variable objects is set, ...
139  Variable::set_output_function(&Variable::default_output_function);
140  // ... the Coefficient constants are initialized, ...
141  Coefficient_constants_initialize();
142  // ... the Linear_Expression class is initialized, ...
143  Linear_Expression::initialize();
144  // ... the Constraint, Generator, Congruence, Grid_Generator,
145  // Constraint_System, Generator_System, Congruence_System,
146  // Grid_Generator_System and Polyhedron classes are initialized, ...
147  Constraint::initialize();
148  Generator::initialize();
149  Congruence::initialize();
150  Grid_Generator::initialize();
151  Constraint_System::initialize();
152  Generator_System::initialize();
153  Congruence_System::initialize();
154  Grid_Generator_System::initialize();
155  Polyhedron::initialize();
156 
157 #if PPL_HAVE_DECL_SETITIMER && PPL_HAVE_DECL_SIGACTION
158  // ... the Watchdog subsystem is initialized, ...
159  Watchdog::Watchdog::initialize();
160 #endif // PPL_HAVE_DECL_SETITIMER && PPL_HAVE_DECL_SIGACTION
161 
162 #if PPL_CAN_CONTROL_FPU
163 
164  // ... and the FPU rounding direction is set.
165  fpu_initialize_control_functions();
166  old_rounding_direction = fpu_get_rounding_direction();
167  fpu_set_rounding_direction(round_fpu_dir(ROUND_DIRECT));
168 
169 #if defined(PPL_ARM_CAN_CONTROL_FPU) && PPL_ARM_CAN_CONTROL_FPU
170  if (ppl_test_rounding() != 0) {
171  throw std::logic_error("PPL configuration error:"
172  " PPL_ARM_CAN_CONTROL_FPU evaluates to true,"
173  " but rounding does not work.");
174  }
175 #endif // defined(PPL_ARM_CAN_CONTROL_FPU) && PPL_ARM_CAN_CONTROL_FPU
176 
177 #endif // PPL_CAN_CONTROL_FPU
178 
179  // The default is chosen to have a precision greater than most
180  // precise IEC 559 floating point (112 bits of mantissa).
181  set_irrational_precision(DEFAULT_IRRATIONAL_PRECISION);
182  }
183 }
Parma_Polyhedra_Library::Init::count
static unsigned int count
Count the number of objects created.
Definition: Init_defs.hh:90
Parma_Polyhedra_Library::Congruence::initialize
static void initialize()
Initializes the class.
Definition: Congruence.cc:270
Parma_Polyhedra_Library::Generator_System::initialize
static void initialize()
Initializes the class.
Definition: Generator_System.cc:838
Parma_Polyhedra_Library::Init::DEFAULT_IRRATIONAL_PRECISION
static const unsigned DEFAULT_IRRATIONAL_PRECISION
Default precision parameter used for irrational calculations.
Definition: Init_defs.hh:87
Parma_Polyhedra_Library::set_irrational_precision
void set_irrational_precision(const unsigned p)
Sets the precision parameter used for irrational calculations.
Definition: checked_mpq_inlines.hh:549
Parma_Polyhedra_Library::Coefficient_constants_initialize
void Coefficient_constants_initialize()
Initializes the Coefficient constants.
Parma_Polyhedra_Library::fpu_get_rounding_direction
fpu_rounding_direction_type fpu_get_rounding_direction()
Returns the current FPU rounding direction.
Definition: fpu-ia32_inlines.hh:132
Parma_Polyhedra_Library::Congruence_System::initialize
static void initialize()
Initializes the class.
Definition: Congruence_System.cc:393
Parma_Polyhedra_Library::round_fpu_dir
fpu_rounding_direction_type round_fpu_dir(Rounding_Dir dir)
Parma_Polyhedra_Library::Linear_Expression::initialize
static void initialize()
Initializes the class.
Definition: Linear_Expression.cc:42
Parma_Polyhedra_Library::Generator::initialize
static void initialize()
Initializes the class.
Definition: Generator.cc:281
Parma_Polyhedra_Library::Variable::default_output_function
static void default_output_function(std::ostream &s, const Variable v)
The default output function.
Definition: Variable.cc:39
Parma_Polyhedra_Library::initialize
void initialize()
Initializes the library.
Definition: initializer.hh:52
Parma_Polyhedra_Library::Init::old_rounding_direction
static fpu_rounding_direction_type old_rounding_direction
Definition: Init_defs.hh:91
Parma_Polyhedra_Library::fpu_initialize_control_functions
void fpu_initialize_control_functions()
Initializes the FPU control functions.
Definition: fpu-ia32_inlines.hh:124
ppl_set_GMP_memory_allocation_functions
void ppl_set_GMP_memory_allocation_functions(void)
Definition: set_GMP_memory_alloc_funcs.cc:30
Parma_Polyhedra_Library::ROUND_DIRECT
Definition: Rounding_Dir_defs.hh:58
Parma_Polyhedra_Library::Grid_Generator_System::initialize
static void initialize()
Initializes the class.
Definition: Grid_Generator_System.cc:144
Parma_Polyhedra_Library::Constraint_System::initialize
static void initialize()
Initializes the class.
Definition: Constraint_System.cc:386
Parma_Polyhedra_Library::Constraint::initialize
static void initialize()
Initializes the class.
Definition: Constraint.cc:271
Parma_Polyhedra_Library::Variable::set_output_function
static void set_output_function(output_function_type *p)
Sets the output function to be used for printing Variable objects.
Definition: Variable_inlines.hh:67
Parma_Polyhedra_Library::fpu_set_rounding_direction
void fpu_set_rounding_direction(fpu_rounding_direction_type dir)
Sets the FPU rounding direction to dir.
Definition: fpu-ia32_inlines.hh:137
Parma_Polyhedra_Library::Grid_Generator::initialize
static void initialize()
Initializes the class.
Definition: Grid_Generator.cc:335
Parma_Polyhedra_Library::Polyhedron::initialize
static void initialize()
Initializes the class.
Definition: Polyhedron_public.cc:47
Parma_Polyhedra_Library::Init::~Init ( )

Finalizes the PPL.

Definition at line 185 of file Init.cc.

References Parma_Polyhedra_Library::Coefficient_constants_finalize(), Parma_Polyhedra_Library::finalize(), Parma_Polyhedra_Library::Constraint_System::finalize(), Parma_Polyhedra_Library::Congruence_System::finalize(), Parma_Polyhedra_Library::Grid_Generator_System::finalize(), Parma_Polyhedra_Library::Generator_System::finalize(), Parma_Polyhedra_Library::Congruence::finalize(), Parma_Polyhedra_Library::Polyhedron::finalize(), Parma_Polyhedra_Library::Constraint::finalize(), Parma_Polyhedra_Library::Grid_Generator::finalize(), Parma_Polyhedra_Library::Generator::finalize(), Parma_Polyhedra_Library::Linear_Expression::finalize(), and Parma_Polyhedra_Library::fpu_set_rounding_direction().

185  {
186  // Only when the last Init object is destroyed...
187  if (--count == 0) {
188 #if PPL_CAN_CONTROL_FPU
189  // ... the FPU rounding direction is restored, ...
190  fpu_set_rounding_direction(old_rounding_direction);
191 #endif
192 
193 #if PPL_HAVE_DECL_SETITIMER && PPL_HAVE_DECL_SIGACTION
194  // ... the Watchdog subsystem is finalized, ...
195  Watchdog::Watchdog::finalize();
196 #endif // PPL_HAVE_DECL_SETITIMER && PPL_HAVE_DECL_SIGACTION
197 
198  // ... the Polyhedron, Grid_Generator_System, Congruence_System,
199  // Generator_System, Constraint_System, Grid_Generator,
200  // Congruence, Generator and Constraint classes are finalized
201  // IN THAT ORDER, ...
202  Polyhedron::finalize();
203  Grid_Generator_System::finalize();
204  Congruence_System::finalize();
205  Generator_System::finalize();
206  Constraint_System::finalize();
207  Grid_Generator::finalize();
208  Congruence::finalize();
209  Generator::finalize();
210  Constraint::finalize();
211  // ... the Linear_Expression class is finalized, ...
212  Linear_Expression::finalize();
213  // ... and the Coefficient constants are finalized.
214  Coefficient_constants_finalize();
215  }
216 }
Parma_Polyhedra_Library::Init::count
static unsigned int count
Count the number of objects created.
Definition: Init_defs.hh:90
Parma_Polyhedra_Library::Coefficient_constants_finalize
void Coefficient_constants_finalize()
Finalizes the Coefficient constants.
Parma_Polyhedra_Library::Linear_Expression::finalize
static void finalize()
Finalizes the class.
Definition: Linear_Expression.cc:48
Parma_Polyhedra_Library::Grid_Generator::finalize
static void finalize()
Finalizes the class.
Definition: Grid_Generator.cc:341
Parma_Polyhedra_Library::Polyhedron::finalize
static void finalize()
Finalizes the class.
Definition: Polyhedron_public.cc:54
Parma_Polyhedra_Library::finalize
void finalize()
Finalizes the library.
Definition: initializer.hh:60
Parma_Polyhedra_Library::Generator::finalize
static void finalize()
Finalizes the class.
Definition: Generator.cc:292
Parma_Polyhedra_Library::Constraint::finalize
static void finalize()
Finalizes the class.
Definition: Constraint.cc:290
Parma_Polyhedra_Library::Congruence::finalize
static void finalize()
Finalizes the class.
Definition: Congruence.cc:281
Parma_Polyhedra_Library::Init::old_rounding_direction
static fpu_rounding_direction_type old_rounding_direction
Definition: Init_defs.hh:91
Parma_Polyhedra_Library::Generator_System::finalize
static void finalize()
Finalizes the class.
Definition: Generator_System.cc:845
Parma_Polyhedra_Library::Grid_Generator_System::finalize
static void finalize()
Finalizes the class.
Definition: Grid_Generator_System.cc:151
Parma_Polyhedra_Library::Constraint_System::finalize
static void finalize()
Finalizes the class.
Definition: Constraint_System.cc:393
Parma_Polyhedra_Library::fpu_set_rounding_direction
void fpu_set_rounding_direction(fpu_rounding_direction_type dir)
Sets the FPU rounding direction to dir.
Definition: fpu-ia32_inlines.hh:137
Parma_Polyhedra_Library::Congruence_System::finalize
static void finalize()
Finalizes the class.
Definition: Congruence_System.cc:400

Friends And Related Function Documentation

void restore_pre_PPL_rounding ( )
friend

Sets the FPU rounding mode as it was before initialization of the PPL.

This is important if the application uses floating-point computations outside the PPL. It is crucial when the application uses functions from a mathematical library that are not guaranteed to work correctly under all rounding modes.

After calling this function it is absolutely necessary to call set_rounding_for_PPL() before using any PPL abstractions based on floating point numbers. This is performed automatically at finalization-time.

Definition at line 40 of file Init_inlines.hh.

40  {
41 #if PPL_CAN_CONTROL_FPU
42  fpu_set_rounding_direction(Init::old_rounding_direction);
43 #endif
44 }
Parma_Polyhedra_Library::Init::old_rounding_direction
static fpu_rounding_direction_type old_rounding_direction
Definition: Init_defs.hh:91
Parma_Polyhedra_Library::fpu_set_rounding_direction
void fpu_set_rounding_direction(fpu_rounding_direction_type dir)
Sets the FPU rounding direction to dir.
Definition: fpu-ia32_inlines.hh:137
void set_rounding_for_PPL ( )
friend

Sets the FPU rounding mode so that the PPL abstractions based on floating point numbers work correctly.

This is performed automatically at initialization-time. Calling this function is needed only if restore_pre_PPL_rounding() has been previously called.

Definition at line 33 of file Init_inlines.hh.

33  {
34 #if PPL_CAN_CONTROL_FPU
35  fpu_set_rounding_direction(round_fpu_dir(ROUND_DIRECT));
36 #endif
37 }
Parma_Polyhedra_Library::round_fpu_dir
fpu_rounding_direction_type round_fpu_dir(Rounding_Dir dir)
Parma_Polyhedra_Library::ROUND_DIRECT
Definition: Rounding_Dir_defs.hh:58
Parma_Polyhedra_Library::fpu_set_rounding_direction
void fpu_set_rounding_direction(fpu_rounding_direction_type dir)
Sets the FPU rounding direction to dir.
Definition: fpu-ia32_inlines.hh:137

Member Data Documentation

unsigned int Parma_Polyhedra_Library::Init::count = 0
staticprivate

Count the number of objects created.

Definition at line 90 of file Init_defs.hh.

Referenced by Init().

const unsigned Parma_Polyhedra_Library::Init::DEFAULT_IRRATIONAL_PRECISION = 128U
staticprivate

Default precision parameter used for irrational calculations.

The default is chosen to have a precision greater than most precise IEC 559 floating point (112 bits of mantissa).

Definition at line 87 of file Init_defs.hh.

Referenced by Init().

PPL::fpu_rounding_direction_type Parma_Polyhedra_Library::Init::old_rounding_direction
staticprivate

Definition at line 91 of file Init_defs.hh.

Referenced by Init(), and Parma_Polyhedra_Library::restore_pre_PPL_rounding().

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