EllipticHelix.h

 
#pragma once
 
#if defined(EllipticHelix_RECURSES)
#error Recursive header files inclusion detected in EllipticHelix.h
#else // defined(EllipticHelix_RECURSES)
#define EllipticHelix_RECURSES
 
#if !defined EllipticHelix_h
#define EllipticHelix_h
 
// Inclusions
#include <iostream>
#include <cmath>
#include "DGtal/base/Common.h"
 
namespace DGtal
{
 
// class EllipticHelix
template <typename TSpace>
class EllipticHelix
{
    // ----------------------- Standard services ------------------------------
public:
    typedef TSpace Space;
    typedef typename TSpace::RealPoint RealPoint;
    typedef typename TSpace::Point Point;
 
    ~EllipticHelix() {}
    EllipticHelix ( long double rr, long double rl,  long double bb );
 
 
    // ----------------------- Interface --------------------------------------
public:
 
    RealPoint x ( long double t ) const;
 
    RealPoint xp ( long double t ) const;
 
    long double f ( const RealPoint & p ) const;
 
    long double g ( const RealPoint & p ) const;
 
    long double h ( const RealPoint & p ) const;
 
    static double getPeriod();
 
    void selfDisplay ( std::ostream & out ) const;
 
    bool isValid() const;
 
 
    // ------------------------- Protected Datas ------------------------------
private:
    // ------------------------- Private Datas --------------------------------
private:
    long double r1, r2, b;
    // ------------------------- Hidden services ------------------------------
protected:
 
    EllipticHelix();
 
private:
 
    EllipticHelix ( const EllipticHelix & other );
 
    EllipticHelix & operator= ( const EllipticHelix & other );
 
 
    // ------------------------- Internals ------------------------------------
private:
 
    static constexpr double PERIOD = M_PI * 2.0;
 
}; // end of class EllipticHelix
 
 
template <typename T>
std::ostream&
operator<< ( std::ostream & out, const EllipticHelix<T> & object );
 
 
} // namespace DGtal
 
 
// Includes inline functions.
#if !defined(BUILD_INLINE)
#include "DGtal/geometry/curves/parametric/EllipticHelix.ih"
#endif
 
 
//                                                                           //
 
#endif // !defined EllipticHelix_h
 
#undef EllipticHelix_RECURSES
#endif // else defined(EllipticHelix_RECURSES)