Zoltan2_GraphMetrics.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//
// Copyright 2012 NTESS and the Zoltan2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

 
#ifndef ZOLTAN2_GRAPHCMETRICS_HPP
#define ZOLTAN2_GRAPHCMETRICS_HPP
 
#include <Zoltan2_BaseClassMetrics.hpp>
#include <Zoltan2_GraphModel.hpp>
#include <Zoltan2_MetricUtility.hpp>
 
#define GRAPH_METRICS_TYPE_NAME "GraphMetrics"
 
namespace Zoltan2{

template <typename scalar_t>
  class GraphMetrics : public BaseClassMetrics<scalar_t> {
 
public:
GraphMetrics(std::string mname) : BaseClassMetrics<scalar_t>(static_metricNames_.size(), mname) {}

GraphMetrics() : BaseClassMetrics<scalar_t>(static_metricNames_.size()) {}

virtual const std::string & getMetricType() const { return GraphMetrics<scalar_t>::static_metricTypeName_; }

static void printHeader(std::ostream &os);

virtual void printLine(std::ostream &os) const;

void setGlobalSum(scalar_t x) { this->setMetricValue("global sum", x);}

void setGlobalMax(scalar_t x) { this->setValue("global maximum", x);}

scalar_t getGlobalSum() const { return this->getMetricValue("global sum");}

scalar_t getGlobalMax() const { return this->getMetricValue("global maximum");}

virtual const std::vector<std::string> & getMetrics() const { return GraphMetrics<scalar_t>::static_metricNames_; }

static std::vector<std::string> static_metricNames_;

static std::string static_metricTypeName_;
};  // end class

template <typename scalar_t>
std::string GraphMetrics<scalar_t>::static_metricTypeName_ = GRAPH_METRICS_TYPE_NAME;

template <typename scalar_t>
std::vector<std::string> GraphMetrics<scalar_t>::static_metricNames_ = {
  "global sum",
  "global maximum"
};
 
template <typename scalar_t>
  void GraphMetrics<scalar_t>::printHeader(std::ostream &os)
{
  os << std::setw(20) << " ";
  os << std::setw(12) << "total" << std::setw(12) << "max";
  os << std::endl;
}
 
template <typename scalar_t>
  void GraphMetrics<scalar_t>::printLine(std::ostream &os) const
{
  std::string label( this->getName() );
 
  os << std::setw(20) << label;
  os << std::setw(12) << std::setprecision(4) << this->getMetricValue("global sum");
  os << std::setw(12) << std::setprecision(4) << this->getMetricValue("global maximum");
 
  os << std::endl;
}
 
} //namespace Zoltan2
#endif