libcruft-util/vector.hpp

83 lines
2.6 KiB
C++
Raw Normal View History

2011-05-23 17:18:52 +10:00
/*
* This file is part of libgim.
2011-05-23 17:18:52 +10:00
*
* libgim is free software: you can redistribute it and/or modify it under the
2011-05-23 17:18:52 +10:00
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
2014-08-18 22:14:31 +10:00
*
* libgim is distributed in the hope that it will be useful, but WITHOUT ANY
2011-05-23 17:18:52 +10:00
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
2014-08-18 22:14:31 +10:00
*
2011-05-23 17:18:52 +10:00
* You should have received a copy of the GNU General Public License
* along with libgim. If not, see <http://www.gnu.org/licenses/>.
2011-05-23 17:18:52 +10:00
*
2012-04-23 13:06:41 +10:00
* Copyright 2011 Danny Robson <danny@nerdcruft.net>
2011-05-23 17:18:52 +10:00
*/
#ifndef __UTIL_VECTOR_HPP
#define __UTIL_VECTOR_HPP
#include "json/tree.hpp"
#include "coord.hpp"
#include <array>
#include <iostream>
#include <initializer_list>
2011-05-23 17:18:52 +10:00
namespace util {
template <size_t S, typename T>
struct vector : public coord::base<S,T,vector,coord::xyzw,coord::stpq>
{
using coord::base<S,T,util::vector,coord::xyzw,coord::stpq>::base;
2011-05-23 17:18:52 +10:00
bool is_zero (void) const;
2011-05-23 17:18:52 +10:00
// vector operators
T magnitude (void) const;
T magnitude2 (void) const;
2011-05-23 17:18:52 +10:00
2015-01-28 15:00:20 +11:00
T difference (const vector<S,T>&) const;
T difference2 (const vector<S,T>&) const;
vector<S,T>& normalise (void);
vector<S,T> normalised [[gnu::warn_unused_result]] (void) const;
2012-05-03 15:56:56 +10:00
// constants
2015-01-15 14:01:51 +11:00
static const vector<S,T> ZERO;
void sanity (void) const;
2011-05-23 17:18:52 +10:00
};
// polar/cartesian conversions; assumes (mag, angle) form.
2015-04-01 17:05:24 +11:00
template <typename T> vector<2,T> polar_to_cartesian (vector<2,T>);
2015-04-02 14:57:30 +11:00
template <typename T> vector<2,T> cartesian_to_polar (vector<2,T>);
template <typename T> vector<3,T> cross (const vector<3,T>&, const vector<3,T>&);
template <typename T> vector<3,T> spherical_to_cartesian (const vector<3,T>&);
template <typename T> vector<3,T> cartesian_to_spherical (const vector<3,T>&);
// output and serialisation operators
template <size_t S, typename T> std::ostream& operator<< (std::ostream&, const vector<S,T>&);
template <size_t S, typename T>
const json::tree::node& operator>> (const json::tree::node&, vector<S,T>&);
// convenience typedefs
typedef vector<2,size_t> vector2u;
typedef vector<2,intmax_t> vector2i;
typedef vector<2,float> vector2f;
typedef vector<3,float> vector3f;
typedef vector<4,float> vector4f;
typedef vector<2,double> vector2d;
typedef vector<3,double> vector3d;
typedef vector<3,double> vector4d;
2011-05-23 17:18:52 +10:00
}
#endif