Zoltan2_BaseClassMetrics.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_BASEMETRICVALUES_HPP
#define ZOLTAN2_BASEMETRICVALUES_HPP

#include <Zoltan2_Standards.hpp>

#define UNKNOWN_METRICS_TYPE_NAME "UnknownMetricClass"  // Unknown would be error
#define METRICS_UNSET_STRING "unset"

namespace Zoltan2{

template <typename scalar_t>
  class BaseClassMetrics {

private:
void resetValues( int memCount ){
  scalar_t *tmp = new scalar_t [memCount];
  memset(tmp, 0, sizeof(scalar_t) * memCount);
  values_ = arcp(tmp, 0, memCount, true);
}

std::string metricName_;

ArrayRCP<scalar_t> values_;

protected:

scalar_t getValue(int enumIndex) const { return values_[enumIndex]; }

void setValue(int enumIndex, scalar_t value) { values_[enumIndex] = value; }

public:

BaseClassMetrics() :
  metricName_(METRICS_UNSET_STRING), values_() {
}

BaseClassMetrics(int memCount, std::string mname) :
  metricName_(mname), values_() {
  resetValues(memCount);
}

BaseClassMetrics(int memCount) :
  metricName_(METRICS_UNSET_STRING), values_() {
  resetValues(memCount);
}
    
virtual ~BaseClassMetrics() {}

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

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

virtual const std::string & getMetricType() const
  { return static_unknown_metricTypeName_; }

const std::string &getName() const { return metricName_; }

void setName(std::string name) { metricName_ = name;}

bool hasMetricValue(const std::string & metric_name) const {
  return( convertMetricNameToIndex( metric_name ) != getMetrics().size() );
}

scalar_t getMetricValue(const std::string & metric_name) const
{
  size_t metricIndex = convertMetricNameToIndex(metric_name);
  if( metricIndex == getMetrics().size() )
    return 0.0; // throw an error
  return values_[metricIndex];
}

void setMetricValue(const std::string & metric_name, scalar_t value) const
{
  size_t metricIndex = convertMetricNameToIndex(metric_name);
  if( metricIndex != getMetrics().size() )
    values_[metricIndex] = value;
}

size_t convertMetricNameToIndex(const std::string & metric_name) const
{
  const std::vector<std::string> & metricNames = getMetrics();
  size_t metricIndex = std::find(metricNames.begin(), metricNames.end(),
    metric_name) - metricNames.begin();
  return metricIndex; // this can return metricNames.size() if not found
}

static std::string static_unknown_metricTypeName_;

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

static std::vector<std::string> static_allMetricNames_;
};

template <typename scalar_t>
std::string BaseClassMetrics<scalar_t>::static_unknown_metricTypeName_ =
  UNKNOWN_METRICS_TYPE_NAME;

template <typename scalar_t>
std::vector<std::string> BaseClassMetrics<scalar_t>::static_metricNames_ = {};

} // namespace Zoltan2
#endif