LSA_Toolkit::Environment Class Reference

API access class for the LSA_Toolkit Environment. More...

#include <environment.h>

List of all members.

Public Member Functions
	Environment ()
	Common Environment constructor for single processor node.
	~Environment ()
	Environment destructor for all forms of Environment objects.
void	setProcessors (long p)
	Set the desired number of processors to use for parallel execution on a multi-computer grid.
long	getDocuments ()
	Retrieve the number of documents recorded in this Environment object.
long	getTerms ()
	Retrieve the number of terms recorded in this Environment object.
void	setVerbosity (bool)
	Set verbose output flag.
void	setDesiredSvals (size_t)
	Set the number of desired singular values for a LSA Space.
Public Attributes
Environment_Impl *	ptr

---

Detailed Description

API access class for the LSA_Toolkit Environment.

The Environment class provides the basis for using the LSA_Toolkit. An Environment object must be instatiated before any of the other toolkit objects are accessable as they all require an Environment object for their instantiation.

The RLM license manager must be running before an Environment object can be constructed.

The Environment object interacts with the license manager to obtain a license to run when the Environment object is constructed. Each Environment object therefore requires its own license. A single Environment object may be used as the basis for multiple objects of the other classes in the LSA_Toolkit.

In a parallel processing grid, each processor node will need an individual Environment object (each with its own license). The instantiation of the Environment object on the master processor will handle the creation of the Environment objects on the other processors. The Environment object carries the designated processor number for each processor in the parallel grid, with the master being numbered 0.

Note:

The Environment object will potentially throw the license_exception execption if there are problems obtaining a license to run during construction, or if communication with the license manager is lost during operation once the Environment object has been instatiated.

---

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

• environment.h
• environment.cpp