libcruft-util/extent.cpp

/*
 * This file is part of libgim.
 *
 * libgim is free software: you can redistribute it and/or modify it under the
 * 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.
 *
 * libgim is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libgim.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright 2010-2015 Danny Robson <danny@nerdcruft.net>
 */

#include "extent.hpp"

#include "debug.hpp"
#include "maths.hpp"

#include <cmath>

///////////////////////////////////////////////////////////////////////////////
template <typename T>
util::extent<T>::extent (const T  _width, const T  _height):
        w (_width),
        h (_height)
{
    CHECK_GE (w, 0);
    CHECK_GE (h, 0);
}


//-----------------------------------------------------------------------------
template <typename T>
util::extent<T>::extent (T t):
    extent (t, t)
{ ; }


//-----------------------------------------------------------------------------
template <typename T>
util::extent<T>::extent (vector<2,T> _v):
    extent (_v.x, _v.y)
{ ; }


//-----------------------------------------------------------------------------
template <typename T>
util::extent<T>::extent (const util::extent<T> &rhs):
        w (rhs.w),
        h (rhs.h)
{ ; }


//-----------------------------------------------------------------------------
template <typename T>
util::extent<T>&
util::extent<T>::operator= (const util::extent<T> &rhs)
{
    w = rhs.w;
    h = rhs.h;

    return *this;
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
T
util::extent<T>::diameter (void) const
{
    return static_cast<T> (sqrt (w * w + h * h));
}


//-----------------------------------------------------------------------------
template <typename T>
T
util::extent<T>::area (void) const
{
    return w * h;
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
util::extent<T>
util::extent<T>::expanded (util::vector<2,T> mag) const
{
    return {
        w + mag.x,
        h + mag.y
    };
}


//-----------------------------------------------------------------------------
template <typename T>
util::extent<T>
util::extent<T>::expanded (T t) const
{
    return expanded (util::vector<2,T> {t});
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
float
util::extent<T>::aspect (void) const
{
    return static_cast<float> (w) / static_cast<float> (h);
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
bool
util::extent<T>::empty (void) const
{
    return almost_equal (area(), 0);
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
T&
util::extent<T>::operator[] (size_t idx)
{
    switch (idx) {
    case 0: return w;
    case 1: return h;

    default:
        unreachable ();
    }
}


//-----------------------------------------------------------------------------
template <typename T>
const T&
util::extent<T>::operator[] (size_t idx) const
{
    switch (idx) {
    case 0: return w;
    case 1: return h;

    default:
        unreachable ();
    }
}


//-----------------------------------------------------------------------------
template <typename T>
size_t
util::extent<T>::size (void) const
{
    return 2u;
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
bool
util::extent<T>::operator ==(const extent& rhs) const
{
    return almost_equal (w, rhs.w) &&
           almost_equal (h, rhs.h);
}


///////////////////////////////////////////////////////////////////////////////
template <typename T>
const util::extent<T> util::extent<T>::MIN {
    0, 0
};


//-----------------------------------------------------------------------------
template <typename T>
const util::extent<T> util::extent<T>::MAX {
    std::numeric_limits<T>::max (),
    std::numeric_limits<T>::max ()
};


///////////////////////////////////////////////////////////////////////////////
namespace debug {
    template <typename T>
    struct validator<util::extent,T> {
        static bool is_valid (const util::extent<T> &e)
        {
            return e.w >= 0 && e.h >= 0;
        }
    };
}

template bool debug::valid (const util::extent<float>&);
template bool debug::valid (const util::extent<double>&);
template bool debug::valid (const util::extent<uint16_t>&);
template bool debug::valid (const util::extent<uint32_t>&);
template bool debug::valid (const util::extent<uint64_t>&);


///////////////////////////////////////////////////////////////////////////////
template <typename T>
std::ostream&
util::operator<< (std::ostream &os, util::extent<T> e)
{
    os << "[" << e.w << ", " << e.h << "]";
    return os;
}


template std::ostream& util::operator<< (std::ostream&, util::extent<uint16_t>);
template std::ostream& util::operator<< (std::ostream&, util::extent<uint32_t>);
template std::ostream& util::operator<< (std::ostream&, util::extent<uint64_t>);
template std::ostream& util::operator<< (std::ostream&, util::extent<float>);
template std::ostream& util::operator<< (std::ostream&, util::extent<double>);


//-----------------------------------------------------------------------------
namespace util {
    template struct extent<uint32_t>;
    template struct extent<uint64_t>;
    template struct extent<float>;
    template struct extent<double>;
}