Zoltan 2 Version 0.5
Public Types | Public Member Functions | Protected Types | Protected Attributes
Zoltan2::OrderingProblem< Adapter > Class Template Reference

OrderingProblem sets up ordering problems for the user. More...

#include <Zoltan2_OrderingProblem.hpp>

Inheritance diagram for Zoltan2::OrderingProblem< Adapter >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::OrderingProblem< Adapter >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Adapter::gid_t gid_t
typedef Adapter::lno_t lno_t

Public Member Functions

virtual ~OrderingProblem ()
 Destructor.
 OrderingProblem (Adapter *A, ParameterList *p)
 Constructor that uses a default communicator.
void solve (bool updateInputData=true)
 Direct the problem to create a solution.
OrderingSolution< gid_t, lno_t > * getSolution ()
 Get the solution to the problem.
void resetParameters (ParameterList *params)
 Reset the list of parameters.
void printTimers () const
 If timer data was collected, print out global data.

Protected Types

typedef Adapter::base_adapter_t base_adapter_t

Protected Attributes

Adapter * inputAdapter_
base_adapter_tbaseInputAdapter_
RCP< GraphModel< base_adapter_t > > graphModel_
RCP< IdentifierModel
< base_adapter_t > > 
identifierModel_
RCP< CoordinateModel
< base_adapter_t > > 
coordinateModel_
RCP< const Model
< base_adapter_t > > 
baseModel_
RCP< ParameterListparams_
RCP< const Comm< int > > comm_
RCP< Environmentenv_
RCP< const EnvironmentenvConst_
RCP< TimerManagertimer_

Detailed Description

template<typename Adapter>
class Zoltan2::OrderingProblem< Adapter >

OrderingProblem sets up ordering problems for the user.

The OrderingProblem is the core of the Zoltan2 ordering API. Based on the the user's input and parameters, the OrderingProblem sets up a computational Model, and a Solution object. When the user calls the solve() method, the OrderingProblem runs the algorithm, after which the Solution object may be obtained by the user.

Todo:
include pointers to examples

The template parameter is the InputAdapter containing the data that is to be partitioned.

Todo:
follow ordering with partitioning

Definition at line 89 of file Zoltan2_OrderingProblem.hpp.


Member Typedef Documentation

template<typename Adapter >
typedef Adapter::gid_t Zoltan2::OrderingProblem< Adapter >::gid_t

Definition at line 93 of file Zoltan2_OrderingProblem.hpp.

template<typename Adapter >
typedef Adapter::lno_t Zoltan2::OrderingProblem< Adapter >::lno_t

Definition at line 94 of file Zoltan2_OrderingProblem.hpp.

template<typename Adapter >
typedef Adapter::base_adapter_t Zoltan2::Problem< Adapter >::base_adapter_t [protected, inherited]

Reimplemented in Zoltan2::PartitioningProblem< Adapter >.

Definition at line 126 of file Zoltan2_Problem.hpp.


Constructor & Destructor Documentation

template<typename Adapter >
virtual Zoltan2::OrderingProblem< Adapter >::~OrderingProblem ( ) [inline, virtual]

Destructor.

Definition at line 102 of file Zoltan2_OrderingProblem.hpp.

template<typename Adapter >
Zoltan2::OrderingProblem< Adapter >::OrderingProblem ( Adapter *  A,
ParameterList p 
) [inline]

Constructor that uses a default communicator.

Definition at line 118 of file Zoltan2_OrderingProblem.hpp.


Member Function Documentation

template<typename Adapter >
void Zoltan2::OrderingProblem< Adapter >::solve ( bool  updateInputData = true) [virtual]

Direct the problem to create a solution.

Implements Zoltan2::Problem< Adapter >.

Definition at line 165 of file Zoltan2_OrderingProblem.hpp.

template<typename Adapter >
OrderingSolution<gid_t, lno_t>* Zoltan2::OrderingProblem< Adapter >::getSolution ( ) [inline]

Get the solution to the problem.

Definition at line 146 of file Zoltan2_OrderingProblem.hpp.

template<typename Adapter >
void Zoltan2::Problem< Adapter >::resetParameters ( ParameterList params) [inherited]

Reset the list of parameters.

Reimplemented in Zoltan2::PartitioningProblem< Adapter >.

Definition at line 270 of file Zoltan2_Problem.hpp.

template<typename Adapter >
void Zoltan2::Problem< Adapter >::printTimers ( ) const [inline, inherited]

If timer data was collected, print out global data.

If the parameter "timer_output_stream" or "timer_output_file" was set, then timing statistics are available and will be printed out to the requested output stream with this call.

All processes in the application must call this, even if they were not all in the problem communicator. All timers are reset back to zero after this call.

Timer starts, stops and displays are ignored if Zoltan2 is compiled with Z2_OMIT_ALL_ERROR_CHECKING.

Definition at line 110 of file Zoltan2_Problem.hpp.


Member Data Documentation

template<typename Adapter >
Adapter* Zoltan2::Problem< Adapter >::inputAdapter_ [protected, inherited]

Definition at line 128 of file Zoltan2_Problem.hpp.

template<typename Adapter >
base_adapter_t* Zoltan2::Problem< Adapter >::baseInputAdapter_ [protected, inherited]

Definition at line 129 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<GraphModel<base_adapter_t> > Zoltan2::Problem< Adapter >::graphModel_ [protected, inherited]

Definition at line 131 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<IdentifierModel<base_adapter_t> > Zoltan2::Problem< Adapter >::identifierModel_ [protected, inherited]

Definition at line 132 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<CoordinateModel<base_adapter_t> > Zoltan2::Problem< Adapter >::coordinateModel_ [protected, inherited]

Definition at line 133 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Model<base_adapter_t> > Zoltan2::Problem< Adapter >::baseModel_ [protected, inherited]

Definition at line 139 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<ParameterList> Zoltan2::Problem< Adapter >::params_ [protected, inherited]

Definition at line 141 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Comm<int> > Zoltan2::Problem< Adapter >::comm_ [protected, inherited]

Definition at line 142 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<Environment> Zoltan2::Problem< Adapter >::env_ [protected, inherited]

Definition at line 148 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Environment> Zoltan2::Problem< Adapter >::envConst_ [protected, inherited]

Definition at line 153 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<TimerManager> Zoltan2::Problem< Adapter >::timer_ [protected, inherited]

Definition at line 157 of file Zoltan2_Problem.hpp.


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