state_mapping.hpp

Go to the documentation of this file.

/***************************************************************************
 *   Software License Agreement (BSD License)                              *
 *   Copyright (C) 2016 by Horatiu George Todoran <todorangrg@gmail.com>   *
 *                                                                         *
 *   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 copyright holder nor the names of its      *
 *      contributors may be used to endorse or promote products derived    *
 *      from this software without specific prior written permission.      *
 *                                                                         *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   *
 *   "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 THE        *
 *   COPYRIGHT HOLDER OR 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.                                           *
 ***************************************************************************/

#ifndef STATE_MAPPING_HPP
#define STATE_MAPPING_HPP

#include <float.h>
#include <memory>

namespace tuw
{
template <typename InputStateType, typename OutputStateType, typename ParamType>
class StateMapping
{
  // special class member functions
public:
  StateMapping(std::shared_ptr<ParamType>& _params) : params_(_params)
  {
  }

public:
  virtual ~StateMapping() = default;

public:
  StateMapping(const StateMapping&) = default;

public:
  StateMapping& operator=(const StateMapping&) = default;

public:
  StateMapping(StateMapping&&) = default;

public:
  StateMapping& operator=(StateMapping&&) = default;

  // pure virtual functions
public:
  virtual std::shared_ptr<OutputStateType>& compute(std::shared_ptr<InputStateType>& _x, const double& _t) = 0;
public:
  virtual void reloadParam() = 0;
public:
  std::shared_ptr<OutputStateType>& output()
  {
    return output_;
  }

protected:
  std::shared_ptr<ParamType> params_;  
protected:
  std::shared_ptr<OutputStateType> output_;  
};
}

#endif  // STATE_MAPPING_HPP