ColoringProblem sets up coloring problems for the user. More...
#include <Zoltan2_ColoringProblem.hpp>
Public Types | |
| typedef Adapter::scalar_t | scalar_t |
| typedef Adapter::zgid_t | zgid_t |
| typedef Adapter::gno_t | gno_t |
| typedef Adapter::lno_t | lno_t |
| typedef Adapter::user_t | user_t |
| typedef Adapter::base_adapter_t | base_adapter_t |
Public Member Functions | |
| virtual | ~ColoringProblem () |
| Destructor. | |
| ColoringProblem (Adapter *A, ParameterList *p) | |
| Constructor that uses a default communicator. | |
| void | solve (bool updateInputData=true) |
| Direct the problem to create a solution. | |
| ColoringSolution< Adapter > * | getSolution () |
| Get the solution to the problem. | |
| RCP< const Comm< int > > | getComm () |
| Return the communicator used by the problem. | |
| void | resetParameters (ParameterList *params) |
| Reset the list of parameters. | |
| void | printTimers () const |
| Return the communicator passed to the problem. | |
Protected Attributes | |
| Adapter * | inputAdapter_ |
| base_adapter_t * | baseInputAdapter_ |
| 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< Algorithm< Adapter > > | algorithm_ |
| RCP< ParameterList > | params_ |
| RCP< const Comm< int > > | comm_ |
| RCP< Environment > | env_ |
| RCP< const Environment > | envConst_ |
| RCP< TimerManager > | timer_ |
Detailed Description
template<typename Adapter>
class Zoltan2::ColoringProblem< Adapter >
ColoringProblem sets up coloring problems for the user.
The ColoringProblem is the core of the Zoltan2 coloring API. Based on the the user's input and parameters, the ColoringProblem sets up a computational Model, and a Solution object. When the user calls the solve() method, the ColoringProblem 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:
- Should Problems and Solution have interfaces for returning views and for returning RCPs? Or just one? At a minimum, we should have the word "View" in function names that return views.
- Todo:
- Currently, only serial and shared-memory coloring are supported.
Definition at line 90 of file Zoltan2_ColoringProblem.hpp.
Member Typedef Documentation
| typedef Adapter::scalar_t Zoltan2::ColoringProblem< Adapter >::scalar_t |
Definition at line 94 of file Zoltan2_ColoringProblem.hpp.
| typedef Adapter::zgid_t Zoltan2::ColoringProblem< Adapter >::zgid_t |
Definition at line 95 of file Zoltan2_ColoringProblem.hpp.
| typedef Adapter::gno_t Zoltan2::ColoringProblem< Adapter >::gno_t |
Definition at line 96 of file Zoltan2_ColoringProblem.hpp.
| typedef Adapter::lno_t Zoltan2::ColoringProblem< Adapter >::lno_t |
Definition at line 97 of file Zoltan2_ColoringProblem.hpp.
| typedef Adapter::user_t Zoltan2::ColoringProblem< Adapter >::user_t |
Definition at line 98 of file Zoltan2_ColoringProblem.hpp.
| typedef Adapter::base_adapter_t Zoltan2::ColoringProblem< Adapter >::base_adapter_t |
Reimplemented from Zoltan2::Problem< Adapter >.
Definition at line 99 of file Zoltan2_ColoringProblem.hpp.
Constructor & Destructor Documentation
| virtual Zoltan2::ColoringProblem< Adapter >::~ColoringProblem | ( | ) | [inline, virtual] |
Destructor.
Definition at line 107 of file Zoltan2_ColoringProblem.hpp.
| Zoltan2::ColoringProblem< Adapter >::ColoringProblem | ( | Adapter * | A, |
| ParameterList * | p | ||
| ) | [inline] |
Constructor that uses a default communicator.
Definition at line 123 of file Zoltan2_ColoringProblem.hpp.
Member Function Documentation
| void Zoltan2::ColoringProblem< Adapter >::solve | ( | bool | updateInputData = true | ) | [virtual] |
Direct the problem to create a solution.
Implements Zoltan2::Problem< Adapter >.
Definition at line 172 of file Zoltan2_ColoringProblem.hpp.
| ColoringSolution<Adapter>* Zoltan2::ColoringProblem< Adapter >::getSolution | ( | ) | [inline] |
Get the solution to the problem.
Definition at line 151 of file Zoltan2_ColoringProblem.hpp.
| RCP<const Comm<int> > Zoltan2::Problem< Adapter >::getComm | ( | ) | [inline, inherited] |
Return the communicator used by the problem.
Definition at line 120 of file Zoltan2_Problem.hpp.
| void Zoltan2::Problem< Adapter >::resetParameters | ( | ParameterList * | params | ) | [inherited] |
Reset the list of parameters.
Reimplemented in Zoltan2::PartitioningProblem< Adapter >.
Definition at line 282 of file Zoltan2_Problem.hpp.
| void Zoltan2::Problem< Adapter >::printTimers | ( | ) | const [inline, inherited] |
Return the communicator passed to the problem.
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 149 of file Zoltan2_Problem.hpp.
Member Data Documentation
Adapter* Zoltan2::Problem< Adapter >::inputAdapter_ [protected, inherited] |
Definition at line 167 of file Zoltan2_Problem.hpp.
base_adapter_t* Zoltan2::Problem< Adapter >::baseInputAdapter_ [protected, inherited] |
Definition at line 168 of file Zoltan2_Problem.hpp.
RCP<GraphModel<base_adapter_t> > Zoltan2::Problem< Adapter >::graphModel_ [protected, inherited] |
Definition at line 170 of file Zoltan2_Problem.hpp.
RCP<IdentifierModel<base_adapter_t> > Zoltan2::Problem< Adapter >::identifierModel_ [protected, inherited] |
Definition at line 171 of file Zoltan2_Problem.hpp.
RCP<CoordinateModel<base_adapter_t> > Zoltan2::Problem< Adapter >::coordinateModel_ [protected, inherited] |
Definition at line 172 of file Zoltan2_Problem.hpp.
RCP<const Model<base_adapter_t> > Zoltan2::Problem< Adapter >::baseModel_ [protected, inherited] |
Definition at line 178 of file Zoltan2_Problem.hpp.
RCP<Algorithm<Adapter> > Zoltan2::Problem< Adapter >::algorithm_ [protected, inherited] |
Definition at line 181 of file Zoltan2_Problem.hpp.
RCP<ParameterList> Zoltan2::Problem< Adapter >::params_ [protected, inherited] |
Definition at line 183 of file Zoltan2_Problem.hpp.
RCP<const Comm<int> > Zoltan2::Problem< Adapter >::comm_ [protected, inherited] |
Definition at line 184 of file Zoltan2_Problem.hpp.
RCP<Environment> Zoltan2::Problem< Adapter >::env_ [protected, inherited] |
Definition at line 190 of file Zoltan2_Problem.hpp.
RCP<const Environment> Zoltan2::Problem< Adapter >::envConst_ [protected, inherited] |
Definition at line 195 of file Zoltan2_Problem.hpp.
RCP<TimerManager> Zoltan2::Problem< Adapter >::timer_ [protected, inherited] |
Definition at line 199 of file Zoltan2_Problem.hpp.
The documentation for this class was generated from the following file:
