Zoltan2
|
PartitioningProblem sets up partitioning problems for the user. More...
#include <Zoltan2_PartitioningProblem.hpp>
Public Types | |
typedef Adapter::scalar_t | scalar_t |
typedef Adapter::gno_t | gno_t |
typedef Adapter::lno_t | lno_t |
typedef Adapter::part_t | part_t |
typedef Adapter::user_t | user_t |
typedef Adapter::base_adapter_t | base_adapter_t |
Public Member Functions | |
PartitioningProblem (Adapter *A, ParameterList *p) | |
Constructor where communicator is the Teuchos default. More... | |
PartitioningProblem (Adapter *A, ParameterList *p, RCP< const Teuchos::Comm< int > > &comm) | |
Constructor where Teuchos communicator is specified. More... | |
~PartitioningProblem () | |
Destructor. More... | |
void | solve (bool updateInputData=true) |
Direct the problem to create a solution. More... | |
const PartitioningSolution< Adapter > & | getSolution () |
Get the solution to the problem. More... | |
const scalar_t | getWeightImbalance (int idx=0) const |
Returns the imbalance of the solution. More... | |
ArrayRCP< const MetricValues< scalar_t > > | getMetrics () const |
Get the array of metrics Metrics were only computed if user requested metrics with a parameter. More... | |
ArrayRCP< const GraphMetricValues< scalar_t > > | getGraphMetrics () const |
Get the array of graphMetrics Graph metrics were only computed if user requested graph metrics with a parameter. More... | |
void | printMetrics (std::ostream &os) const |
Print the array of metrics. More... | |
void | printGraphMetrics (std::ostream &os) const |
Print the array of metrics. More... | |
void | setPartSizes (int len, part_t *partIds, scalar_t *partSizes, bool makeCopy=true) |
Set or reset relative sizes for the parts that Zoltan2 will create. More... | |
void | setPartSizesForCriteria (int criteria, int len, part_t *partIds, scalar_t *partSizes, bool makeCopy=true) |
Set or reset the relative sizes (per weight) for the parts that Zoltan2 will create. More... | |
void | resetParameters (ParameterList *params) |
Reset the list of parameters. More... | |
const RCP< const Environment > & | getEnvironment () const |
Get the current Environment. Useful for testing. More... | |
![]() | |
Problem (const Adapter *input, ParameterList *params) | |
Constructor where communicator is Teuchos default. More... | |
Problem (const Adapter *input, ParameterList *params, 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... | |
Additional Inherited Members | |
![]() | |
typedef Adapter::base_adapter_t | base_adapter_t |
![]() | |
RCP< const Adapter > | inputAdapter_ |
RCP< const 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_ |
PartitioningProblem sets up partitioning problems for the user.
The PartitioningProblem is the core of the Zoltan2 partitioning API. Based on the the user's input and parameters, the PartitioningProblem sets up a computational Model, and a Solution object. When the user calls the solve() method, the PartitioningProblem runs the algorithm, after which the Solution object may be obtained by the user.
include pointers to examples
repartition given an initial solution
follow partitioning with global or local ordering
allow unsetting of part sizes by passing in null pointers
add a parameter by which user tells us there are no self edges to be removed.
- 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.
The template parameter is the InputAdapter containing the data that is to be partitioned.
Definition at line 101 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::scalar_t Zoltan2::PartitioningProblem< Adapter >::scalar_t |
Definition at line 105 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::gno_t Zoltan2::PartitioningProblem< Adapter >::gno_t |
Definition at line 106 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::lno_t Zoltan2::PartitioningProblem< Adapter >::lno_t |
Definition at line 107 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::part_t Zoltan2::PartitioningProblem< Adapter >::part_t |
Definition at line 108 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::user_t Zoltan2::PartitioningProblem< Adapter >::user_t |
Definition at line 109 of file Zoltan2_PartitioningProblem.hpp.
typedef Adapter::base_adapter_t Zoltan2::PartitioningProblem< Adapter >::base_adapter_t |
Definition at line 110 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Constructor where communicator is the Teuchos default.
Definition at line 131 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Constructor where Teuchos communicator is specified.
Definition at line 146 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Destructor.
Definition at line 163 of file Zoltan2_PartitioningProblem.hpp.
|
virtual |
Direct the problem to create a solution.
Implements Zoltan2::Problem< Adapter >.
Definition at line 516 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Get the solution to the problem.
Definition at line 188 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Returns the imbalance of the solution.
idx | If there are multiple weights per object, specify the index for which the imbalance is desired, ranging from zero to one less then number of weights per object. Imbalance was only computed if user requested metrics with a parameter. |
Definition at line 200 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Get the array of metrics Metrics were only computed if user requested metrics with a parameter.
Definition at line 212 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Get the array of graphMetrics Graph metrics were only computed if user requested graph metrics with a parameter.
Definition at line 225 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Print the array of metrics.
os | the output stream for the report. Metrics were only computed if user requested metrics with a parameter. |
Definition at line 239 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Print the array of metrics.
os | the output stream for the report. Metrics were only computed if user requested metrics with a parameter. |
Definition at line 251 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Set or reset relative sizes for the parts that Zoltan2 will create.
len | The size of the partIds and partSizes lists |
partIds | A list of len part identifiers. Part identifiers range from zero to one less than the global number of identifiers. |
partSizes | A list of len relative sizes corresponding to the partIds . |
makeCopy | If true, Zoltan2 will make a copy of the ids and sizes that are provided in this call. If false, Zoltan2 will just save the pointers to to the caller's lists. If the pointers will remain remain valid throughout the lifetime of the PartitioningProblem, and memory use is an issue, then set makeCopy to false. By default, Zoltan2 will copy the caller's list of ids and sizes. |
A given partid should be provided only once across all ranks. Duplicate partIds will generate a std::runtime_error exception when the PartitioningSolution is created. Part ids that are omitted will be assigned the average of the sizes that have been specified.
Subsequent calls to setPartSizes will replace the list of part ids and part sizes provided previously.
If the application has set multiple weights per object, then the part sizes supplied in this method are applied to the first weight.
Zoltan2 assumes that uniform part sizes are desired by the caller, unless specified otherwise in a call to setPartSizes or setPartSizesForCriteria.
Definition at line 296 of file Zoltan2_PartitioningProblem.hpp.
void Zoltan2::PartitioningProblem< Adapter >::setPartSizesForCriteria | ( | int | criteria, |
int | len, | ||
part_t * | partIds, | ||
scalar_t * | partSizes, | ||
bool | makeCopy = true |
||
) |
Set or reset the relative sizes (per weight) for the parts that Zoltan2 will create.
criteria | the criteria for which these part sizes apply. Criteria range from zero to one less than the number of weights per object specified in the caller's InputAdapter. |
len | The size of the partIds and partSizes lists |
partIds | A list of len part identifiers. Part identifiers range from zero to one less than the global number of identifiers. |
partSizes | A list of len relative sizes corresponding to the partIds . |
makeCopy | If true, Zoltan2 will make a copy of the ids and sizes that are provided in this call. If false, Zoltan2 will just save the pointers to to the caller's lists. If the pointers will remain remain valid throughout the lifetime of the PartitioningProblem, and memory use is an issue, then set makeCopy to false. By default, Zoltan2 will copy the caller's list of ids and sizes. |
A given partid should only be provided once across the application. Duplicate partIds will generate a std::runtime_error exception when the PartitioningSolution is created. Part ids that are omitted will be assigned the average of the sizes that have been specified.
Subsequent calls to setPartSizes for the same criteria will replace the list of part ids and part sizes provided for that criteria previously.
Zoltan2 assumes that uniform part sizes are desired by the caller, unless specified otherwise in a call to setPartSizes or setPartSizesForCriteria.
Definition at line 472 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Reset the list of parameters.
Definition at line 343 of file Zoltan2_PartitioningProblem.hpp.
|
inline |
Get the current Environment. Useful for testing.
Definition at line 352 of file Zoltan2_PartitioningProblem.hpp.