angle.functions.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   numeric/angle.functions.hh
/// @brief  Trigonometric functions
/// @author Frank M. D'Ippolito (Objexx@objexx.com)
/// @author Stuart G. Mentzer (Stuart_Mentzer@objexx.com)


#ifndef INCLUDED_numeric_angle_functions_hh
#define INCLUDED_numeric_angle_functions_hh


// Package headers
#include <numeric/numeric.functions.hh>
#include <numeric/NumericTraits.hh>

// C++ headers
#include <cmath>


namespace numeric {


/// @brief Principal value of angle in radians on ( -pi, pi ]
template< typename T >
inline
T
principal_angle( T const & angle )
{
  return remainder( angle, numeric::NumericTraits< T >::pi_2() );
}


/// @brief Principal value of angle in radians on ( -pi, pi ]
template< typename T >
inline
T
principal_angle_radians( T const & angle )
{
  return remainder( angle, numeric::NumericTraits< T >::pi_2() );
}


/// @brief Principal value of angle in degrees on ( -180, 180 ]
template< typename T >
inline
T
principal_angle_degrees( T const & angle )
{
  return remainder( angle, T( 360.0 ) );
}


/// @brief Positive principal value of angle in radians on [ 0, 2*pi )
template< typename T >
inline
T
nonnegative_principal_angle( T const & angle )
{
  return modulo( angle, numeric::NumericTraits< T >::pi_2() );
}


/// @brief Positive principal value of angle in radians on [ 0, 2*pi )
template< typename T >
inline
T
nonnegative_principal_angle_radians( T const & angle )
{
  return modulo( angle, numeric::NumericTraits< T >::pi_2() );
}


/// @brief Positive principal value of angle in degrees on [ 0, 360 )
template< typename T >
inline
T
nonnegative_principal_angle_degrees( T const & angle )
{
  return modulo( angle, T( 360.0 ) );
}


/// @brief Nearest periodic value of angle to a base angle in radians
template< typename T >
inline
T
nearest_angle( T const & angle, T const & base_angle )
{
  return angle - ( nearest_ssize( ( angle - base_angle ) / numeric::NumericTraits< T >::pi_2() ) * numeric::NumericTraits< T >::pi_2() );
}


/// @brief Nearest periodic value of angle to a base angle in radians
template< typename T >
inline
T
nearest_angle_radians( T const & angle, T const & base_angle )
{
  return angle - ( nearest_ssize( ( angle - base_angle ) / numeric::NumericTraits< T >::pi_2() ) * numeric::NumericTraits< T >::pi_2() );
}


/// @brief Nearest periodic value of angle to a base angle in degrees
template< typename T >
inline
T
nearest_angle_degrees( T const & angle, T const & base_angle )
{
  return angle - ( nearest_ssize( ( angle - base_angle ) / T( 360.0 ) ) * T( 360.0 ) );
}


} // namespace numeric


#endif // INCLUDED_numeric_angle_functions_HH