Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Zoltan2::ColoringProblem< Adapter > Class Template Reference

ColoringProblem sets up coloring problems for the user. More...

#include <Zoltan2_ColoringProblem.hpp>

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

Public Types

typedef Adapter::scalar_t scalar_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. More...
 
 ColoringProblem (Adapter *A, ParameterList *p, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Constructor that uses a Teuchos::Comm. More...
 
 ColoringProblem (Adapter *A, ParameterList *p)
 Constructor that uses a default communicator. More...
 
void solve (bool updateInputData=true)
 Direct the problem to create a solution. More...
 
ColoringSolution< Adapter > * getSolution ()
 Get the solution to the problem. More...
 
- Public Member Functions inherited from Zoltan2::Problem< Adapter >
 Problem (const Adapter *input, ParameterList *params, const RCP< const Comm< int > > &comm)
 Constructor where Teuchos communicator is specified. More...
 
virtual ~Problem ()
 Destructor. More...
 
RCP< const Comm< int > > getComm ()
 Return the communicator used by the problem. More...
 
void resetParameters (ParameterList *params)
 Reset the list of parameters. More...
 
void printTimers () const
 Return the communicator passed to the problem. More...
 
const RCP< const Environment > & getEnvironment () const
 Get the current Environment. Useful for testing. More...
 
- Public Member Functions inherited from Zoltan2::ProblemRoot
virtual ~ProblemRoot ()
 

Static Public Member Functions

static void getValidParameters (ParameterList &pl)
 Set up validators specific to this Problem. More...
 
- Static Public Member Functions inherited from Zoltan2::Problem< Adapter >
static void getValidParameters (ParameterList &pl)
 

Additional Inherited Members

- Protected Types inherited from Zoltan2::Problem< Adapter >
typedef Adapter::base_adapter_t base_adapter_t
 
- Protected Attributes inherited from Zoltan2::Problem< Adapter >
RCP< const Adapter > inputAdapter_
 
RCP< const 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< Algorithm< Adapter > > algorithm_
 
RCP< ParameterList > params_
 
RCP< const Comm< int > > comm_
 
RCP< Environmentenv_
 
RCP< const EnvironmentenvConst_
 
RCP< TimerManagertimer_
 

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 88 of file Zoltan2_ColoringProblem.hpp.

Member Typedef Documentation

template<typename Adapter>
typedef Adapter::scalar_t Zoltan2::ColoringProblem< Adapter >::scalar_t

Definition at line 92 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
typedef Adapter::gno_t Zoltan2::ColoringProblem< Adapter >::gno_t

Definition at line 93 of file Zoltan2_ColoringProblem.hpp.

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

Definition at line 94 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
typedef Adapter::user_t Zoltan2::ColoringProblem< Adapter >::user_t

Definition at line 95 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
typedef Adapter::base_adapter_t Zoltan2::ColoringProblem< Adapter >::base_adapter_t

Definition at line 96 of file Zoltan2_ColoringProblem.hpp.

Constructor & Destructor Documentation

template<typename Adapter>
virtual Zoltan2::ColoringProblem< Adapter >::~ColoringProblem ( )
inlinevirtual

Destructor.

Definition at line 104 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
Zoltan2::ColoringProblem< Adapter >::ColoringProblem ( Adapter *  A,
ParameterList *  p,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inline

Constructor that uses a Teuchos::Comm.

Definition at line 108 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
Zoltan2::ColoringProblem< Adapter >::ColoringProblem ( Adapter *  A,
ParameterList *  p 
)
inline

Constructor that uses a default communicator.

Definition at line 128 of file Zoltan2_ColoringProblem.hpp.

Member Function Documentation

template<typename Adapter>
static void Zoltan2::ColoringProblem< Adapter >::getValidParameters ( ParameterList &  pl)
inlinestatic

Set up validators specific to this Problem.

Definition at line 134 of file Zoltan2_ColoringProblem.hpp.

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

Direct the problem to create a solution.

Implements Zoltan2::ProblemRoot.

Definition at line 179 of file Zoltan2_ColoringProblem.hpp.

template<typename Adapter>
ColoringSolution<Adapter>* Zoltan2::ColoringProblem< Adapter >::getSolution ( )
inline

Get the solution to the problem.

Definition at line 165 of file Zoltan2_ColoringProblem.hpp.


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