Zoltan2_GraphMetrics.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Karen Devine      (kddevin@sandia.gov)
//                    Erik Boman        (egboman@sandia.gov)
//                    Siva Rajamanickam (srajama@sandia.gov)
//
// ***********************************************************************
//
// @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