ROL_SampledScalar.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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 lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER


#ifndef ROL_SAMPLEDSCALAR_H
#define ROL_SAMPLEDSCALAR_H

namespace ROL {

template <class Real>
class SampledScalar {
private:
  // Storage
  std::map<std::vector<Real>, int>          indices_;
  std::vector<bool>                         flags_;
  std::vector<Real>                         scalars_;
  int maxIndex_;

  // Update flags
  bool updated_;

  void reset(const bool flag = true) {
    if ( flag ) {
      typename std::map<std::vector<Real>, int>::iterator it;
      for (it = indices_.begin(); it != indices_.end(); ++it) {
        flags_[it->second] = false;
      }
    }
  }

public:
  SampledScalar(void)
    : maxIndex_(0), updated_(false) { 
    indices_.clear();
    flags_.clear();
    scalars_.clear();
  }

  void update(const bool flag = true) {
    updated_ = flag;
    reset(flag);
  }

  bool get(Real &x,
           const std::vector<Real> &param) {
    int count = indices_.count(param);
    bool flag = false;
    int index = maxIndex_;
    if (count) {
      typename std::map<std::vector<Real>, int>::iterator it
        = indices_.find(param);
      index = it->second;
      flag  = flags_[index];
      if (flag) {
        x = scalars_[index];
      }
    }
    else {
      indices_.insert(
        std::pair<std::vector<Real>, int>(param, index));
      flags_.push_back(false);
      scalars_.push_back(static_cast<Real>(0)); 
      maxIndex_++;
    }
    return flag;
  }

  void set(const Real &x,
           const std::vector<Real> &param) {
    int count = indices_.count(param);
    int index = maxIndex_;
    if (count) {
      typename std::map<std::vector<Real>, int>::iterator it
        = indices_.find(param);
      index = it->second;
      flags_[index] = true;
      scalars_[index] = x;
    }
    else {
      indices_.insert(
        std::pair<std::vector<Real>, int>(param, index));
      flags_.push_back(true);
      scalars_.push_back(x); 
      maxIndex_++;
    }
  }
}; // class SampledScalar

} // namespace ROL

#endif