/*
 * Copyright (C) 2015 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_MATH_SPLINEPRIVATE_HH_
#define GZ_MATH_SPLINEPRIVATE_HH_

#include <algorithm>
#include <vector>
#include <gz/math/Vector3.hh>
#include <gz/math/Vector4.hh>
#include <gz/math/Matrix4.hh>
#include <gz/math/config.hh>

namespace ignition
{
  namespace math
  {
    inline namespace IGNITION_MATH_VERSION_NAMESPACE
    {
    /// \brief Control point representation for
    /// polynomial interpolation, defined in terms
    /// of arbitrary m derivatives at such point.
    class ControlPoint
    {
      /// \brief Default constructor.
      public: ControlPoint()
      {
      }

      /// \brief Constructor that takes the M derivatives that
      /// define the control point.
      /// \param[in] _initList with the M derivatives.
      public: explicit ControlPoint(const std::vector<Vector3d> &_initList)
          : derivatives(_initList.begin(), _initList.end())
      {
      }

      /// \brief Matches all mth derivatives defined in \p _other
      /// to this.
      /// \remarks Higher order derivatives in this and not defined
      /// in \p _other are kept.
      /// \param[in] _other control point to be matches.
      public: inline void Match(const ControlPoint &_other)
      {
        std::copy(_other.derivatives.begin(),
                  _other.derivatives.end(),
                  this->derivatives.begin());
      }

      /// \brief Checks for control point equality.
      /// \param[in] _other control point to compare against.
      /// \return whether this and \p _other can be seen as equal.
      public: inline bool operator==(const ControlPoint &_other) const
      {
        // Workaround to compare the two vector of vectors in MSVC 2013
        // and MSVC 2015. See
        // https://github.com/ignitionrobotics/ign-math/issues/70
        if (this->derivatives.size() != _other.derivatives.size())
          return false;

        for (size_t i = 0; i < this->derivatives.size(); ++i)
          if (this->derivatives[i] != _other.derivatives[i])
            return false;

        return true;
      }

      /// \brief Gets the mth derivative of this control point.
      /// \remarks Higher derivatives than those defined
      /// default to [0.0, 0.0, 0.0].
      /// \param[in] _mth derivative order.
      /// \return The mth derivative value.
      public: inline Vector3d MthDerivative(const unsigned int _mth) const
      {
        if (_mth >= this->derivatives.size())
          return Vector3d(0.0, 0.0, 0.0);
        return this->derivatives[_mth];
      }

      /// \brief Returns a mutable reference to the mth derivative of
      /// this control point.
      /// \remarks Higher derivatives than those defined
      /// default to [0.0, 0.0, 0.0].
      /// \param[in] _mth derivative order.
      /// \return The mth derivative value.
      public: inline Vector3d& MthDerivative(const unsigned int _mth)
      {
        if (_mth >= this->derivatives.size())
        {
          this->derivatives.insert(this->derivatives.end(),
                                   _mth - this->derivatives.size() + 1,
                                   Vector3d(0.0, 0.0, 0.0));
        }
        return this->derivatives[_mth];
      }

      /// \brief control point M derivatives (0 to M-1).
      private: std::vector<Vector3d> derivatives;
    };

    /// \brief Cubic interpolator for splines defined
    /// between each pair of control points.
    class IntervalCubicSpline
    {
      /// \brief Dummy constructor.
      public: IntervalCubicSpline();

      /// \brief Sets both control points.
      /// \param[in] _startPoint start control point.
      /// \param[in] _endPoint end control point.
      public: void SetPoints(const ControlPoint &_startPoint,
                             const ControlPoint &_endPoint);

      /// \brief Gets the start control point.
      /// \return the start control point.
      public: inline const ControlPoint &StartPoint() const
      {
        return this->startPoint;
      };

      /// \brief Gets the end control point.
      /// \return the end control point.
      public: inline const ControlPoint &EndPoint() const
      {
        return this->endPoint;
      };

      /// \brief Interpolates the curve mth derivative at
      /// parameter value \p _t.
      /// \param[in] _mth order of curve derivative to interpolate.
      /// \param[in] _t parameter value (range 0 to 1).
      /// \return the interpolated mth derivative, or [INF, INF, INF]
      /// on error. Use Vector3d::IsFinite() to check for an error.
      public: Vector3d InterpolateMthDerivative(
          const unsigned int _mth, const double _t) const;

      /// \brief Gets curve arc length
      /// \return the arc length
      public: inline double ArcLength() const { return this->arcLength; }

      /// \brief Gets curve arc length up to a given point \p _t.
      /// \param[in] _t parameter value (range 0 to 1).
      /// \return the arc length up to \p _t or INF on error.
      public: double ArcLength(const double _t) const;

      /// \internal
      /// \brief Interpolates the curve mth derivative at parameter
      /// value \p _t.
      /// \param[in] _mth order of curve derivative to interpolate.
      /// \param[in] _t parameter value (range 0 to 1).
      /// \return the interpolated mth derivative of the curve.
      private: Vector3d DoInterpolateMthDerivative(
          const unsigned int _mth, const double _t) const;

      /// \brief start control point for the curve.
      private: ControlPoint startPoint;

      /// \brief end control point for the curve.
      private: ControlPoint endPoint;

      /// \brief Bernstein-Hermite polynomial coefficients
      /// for interpolation.
      private: Matrix4d coeffs;

      /// \brief curve arc length.
      private: double arcLength;
    };

    /// \brief Private data for Spline class.
    class SplinePrivate
    {
      /// \brief when true, the tangents are recalculated when the control
      /// point change.
      public: bool autoCalc;

      /// \brief tension of 0 = Catmull-Rom spline, otherwise a Cardinal spline.
      public: double tension;

      /// \brief fixings for control points.
      public: std::vector<bool> fixings;

      /// \brief control points.
      public: std::vector<ControlPoint> points;

      // \brief interpolated segments.
      public: std::vector<IntervalCubicSpline> segments;

      // \brief segments arc length cumulative distribution.
      public: std::vector<double> cumulativeArcLengths;

      // \brief spline arc length.
      public: double arcLength;
    };
    }
  }
}

#endif
