ROL_VectorController.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef ROL_SIMCONTROLLER_H
#define ROL_SIMCONTROLLER_H

#include "ROL_Vector.hpp"
#include "ROL_UpdateType.hpp"
#include <map>
#include <vector>

namespace ROL {

template <class Real, class Key=std::vector<Real>>
class VectorController {
private:
  // Storage
  std::map<Key,int>               indices_, indices_trial_, indices_temp_;
  std::vector<bool>               flags_, flags_trial_, flags_temp_;
  std::vector<Ptr<Vector<Real>>>  vectors_, vectors_trial_, vectors_temp_;
  int maxIndex_, maxIndex_trial_, maxIndex_temp_;

  // Update flags
  bool trial_, temp_;
  bool objUpdated_, conUpdated_;

public:
  VectorController(void);

  void reset(bool flag = true);

  void objectiveUpdate(bool flag = true);

  void constraintUpdate(bool flag = true);

  void objectiveUpdate(UpdateType type);

  void constraintUpdate(UpdateType type);

  bool isNull(const Key &param) const;

  bool isComputed(const Key &param) const;

  void allocate(const Vector<Real> &x, const Key &param);

  const Ptr<Vector<Real>> set(const Key &param);

  const Ptr<const Vector<Real>> get(const Key &param) const;

  bool get(Vector<Real> &x, const Key &param);

  void set(const Vector<Real> &x, const Key &param);

  void push(VectorController<Real,Key> &to) const;

private:

  void resetTrial(void);

  void resetTemp(void);

  bool isNull(const Key &param, const std::map<Key,int> &indices) const;

  bool isComputed(const Key &param, const std::map<Key,int> &indices,
           const std::vector<bool> &flags) const;

  void allocate(const Vector<Real> &x, const Key &param,
           std::map<Key,int> &indices, std::vector<bool> &flags,
           std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;

  const Ptr<const Vector<Real>> get(const Key &param,
           const std::map<Key,int> &indices, const std::vector<bool> &flags,
           const std::vector<Ptr<Vector<Real>>> &vectors, const int &maxIndex) const;

  const Ptr<Vector<Real>> set(const Key &param,
           std::map<Key,int> &indices, std::vector<bool> &flags,
           std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;

  bool get(Vector<Real> &x, const Key &param,
           std::map<Key,int> &indices, std::vector<bool> &flags,
           std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;

  void set(const Vector<Real> &x, const Key &param,
           std::map<Key,int> &indices, std::vector<bool> &flags,
           std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;

  void accept(void);
}; // class VectorController

} // namespace ROL

#include "ROL_VectorController_Def.hpp"

#endif