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

#include <Zoltan2_ColoringProblem.hpp>

Inheritance diagram for Zoltan2::ColoringProblem< Adapter >:

[legend]

Collaboration diagram for Zoltan2::ColoringProblem< Adapter >:

[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.
	ColoringProblem (Adapter A, ParameterList p, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
	Constructor that uses a Teuchos::Comm.
	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.
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.
virtual	~Problem ()
	Destructor.
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.
const RCP< const Environment > &	getEnvironment () const
	Get the current Environment. Useful for testing.
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.
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_t >	baseInputAdapter_
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