magnum/src/Magnum/Math/Test/PackingTest.cpp

/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016
              Vladimír Vondruš <mosra@centrum.cz>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#include <limits>
#include <Corrade/TestSuite/Tester.h>

#include "Magnum/Math/Packing.h"
#include "Magnum/Math/Vector3.h"

namespace Magnum { namespace Math { namespace Test {

struct PackingTest: Corrade::TestSuite::Tester {
    explicit PackingTest();

    void bitMax();

    void unpackUnsigned();
    void unpackSigned();
    void packUnsigned();
    void packSigned();
    void reunpackUnsinged();
    void reunpackSinged();
    void unpackTypeDeduction();
};

typedef Math::Vector3<Float> Vector3;
typedef Math::Vector3<UnsignedByte> Vector3ub;
typedef Math::Vector3<Byte> Vector3b;

PackingTest::PackingTest() {
    addTests({&PackingTest::bitMax,

              &PackingTest::unpackUnsigned,
              &PackingTest::unpackSigned,
              &PackingTest::packUnsigned,
              &PackingTest::packSigned,
              &PackingTest::reunpackUnsinged,
              &PackingTest::reunpackSinged,
              &PackingTest::unpackTypeDeduction});
}

void PackingTest::bitMax() {
    CORRADE_COMPARE(Implementation::bitMax<UnsignedByte>(), 0xff);
    CORRADE_COMPARE(Implementation::bitMax<Byte>(), 0x7f);
    CORRADE_COMPARE(Implementation::bitMax<UnsignedShort>(), 0xffff);
    CORRADE_COMPARE(Implementation::bitMax<Short>(), 0x7fff);
    CORRADE_COMPARE(Implementation::bitMax<UnsignedInt>(), 0xffffffff);
    CORRADE_COMPARE(Implementation::bitMax<Int>(), 0x7fffffff);
    #ifndef CORRADE_TARGET_EMSCRIPTEN
    CORRADE_COMPARE(Implementation::bitMax<UnsignedLong>(), 0xffffffffffffffffull);
    CORRADE_COMPARE(Implementation::bitMax<Long>(), 0x7fffffffffffffffll);
    #endif

    CORRADE_COMPARE((Implementation::bitMax<UnsignedShort, 14>()), 16383);
    CORRADE_COMPARE((Implementation::bitMax<UnsignedInt, 14>()), 16383);
    CORRADE_COMPARE((Implementation::bitMax<Short, 14>()), 8191);
    CORRADE_COMPARE((Implementation::bitMax<Int, 14>()), 8191);
}

void PackingTest::unpackUnsigned() {
    CORRADE_COMPARE((Math::unpack<Float, UnsignedByte>(0)), 0.0f);
    CORRADE_COMPARE((Math::unpack<Float, UnsignedByte>(149)), 0.584314f);
    CORRADE_COMPARE((Math::unpack<Float, UnsignedByte>(255)), 1.0f);

    CORRADE_COMPARE((Math::unpack<Double, UnsignedInt>(0)), 0.0);
    CORRADE_COMPARE((Math::unpack<Double, UnsignedInt>(std::numeric_limits<UnsignedInt>::max())), 1.0);

    #ifndef MAGNUM_TARGET_WEBGL
    CORRADE_COMPARE((Math::unpack<long double, UnsignedLong>(0)), 0.0);
    CORRADE_COMPARE((Math::unpack<long double, UnsignedLong>(std::numeric_limits<UnsignedLong>::max())), 1.0);
    #endif

    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(0)), 0.0f);
    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(std::numeric_limits<UnsignedShort>::max())), 1.0f);

    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(8192)), 0.125002f);
    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(49152)), 0.750011f);

    /* Bits */
    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(8191)), 0.124987f);
    CORRADE_COMPARE((Math::unpack<Float, UnsignedShort, 14>(8191)), 0.499969f);
    CORRADE_COMPARE((Math::unpack<Float, 14>(8191u)), 0.499969f);
    CORRADE_COMPARE((Math::unpack<Float, 14>(8191)), 1.0f);

    /* Vector overloads */
    CORRADE_COMPARE(Math::unpack<Vector3>(Vector3ub(0, 127, 255)), Vector3(0.0f, 0.498039f, 1.0f));
    CORRADE_COMPARE((Math::unpack<Vector3, 6>(Vector3ub(0, 31, 63))), Vector3(0.0f, 0.492063f, 1.0f));
}

void PackingTest::unpackSigned() {
    CORRADE_COMPARE((Math::unpack<Float, Byte>(127)), 1.0f);
    CORRADE_COMPARE((Math::unpack<Float, Byte>(37)), 0.291339f);
    CORRADE_COMPARE((Math::unpack<Float, Byte>(0)), 0.0f);
    CORRADE_COMPARE((Math::unpack<Float, Byte>(-72)), -0.566929f);
    CORRADE_COMPARE((Math::unpack<Float, Byte>(-128)), -1.0f);

    CORRADE_COMPARE((Math::unpack<Float, Short>(std::numeric_limits<Short>::min())), -1.0f);
    CORRADE_COMPARE((Math::unpack<Float, Short>(0)), 0.0f);
    CORRADE_COMPARE((Math::unpack<Float, Short>(std::numeric_limits<Short>::max())), 1.0f);

    CORRADE_COMPARE((Math::unpack<Double, Int>(std::numeric_limits<Int>::min())), -1.0);
    CORRADE_COMPARE((Math::unpack<Double, Int>(0)), 0.0);
    CORRADE_COMPARE((Math::unpack<Double, Int>(std::numeric_limits<Int>::max())), 1.0);

    #ifndef MAGNUM_TARGET_WEBGL
    CORRADE_COMPARE((Math::unpack<long double, Long>(std::numeric_limits<Long>::min())), -1.0);
    CORRADE_COMPARE((Math::unpack<long double, Long>(0)), 0.0);
    CORRADE_COMPARE((Math::unpack<long double, Long>(std::numeric_limits<Long>::max())), 1.0);
    #endif

    CORRADE_COMPARE((Math::unpack<Float, Short>(16384)), 0.500015f);
    CORRADE_COMPARE((Math::unpack<Float, Short>(-16384)), -0.500015f);

    /* Bits */
    CORRADE_COMPARE((Math::unpack<Float, Short>(8191)), 0.249977f);
    CORRADE_COMPARE((Math::unpack<Float, 14>(8191)), 1.0f);

    /* Vector overloads */
    CORRADE_COMPARE(Math::unpack<Vector3>(Vector3b(0, -127, 64)), Vector3(0.0f, -1.0f, 0.503937f));
    CORRADE_COMPARE((Math::unpack<Vector3, 6>(Vector3b(0, -31, 16))), Vector3(0.0f, -1.0f, 0.516129f));
}

void PackingTest::packUnsigned() {
    CORRADE_COMPARE(Math::pack<UnsignedByte>(0.0f), 0);
    CORRADE_COMPARE(Math::pack<UnsignedByte>(0.4357f), 111);
    CORRADE_COMPARE(Math::pack<UnsignedByte>(1.0f), 255);

    CORRADE_COMPARE(Math::pack<UnsignedShort>(0.0f), 0);
    CORRADE_COMPARE(Math::pack<UnsignedShort>(1.0f), std::numeric_limits<UnsignedShort>::max());

    CORRADE_COMPARE(Math::pack<UnsignedInt>(0.0), 0);
    CORRADE_COMPARE(Math::pack<UnsignedInt>(1.0), std::numeric_limits<UnsignedInt>::max());

    #ifndef MAGNUM_TARGET_WEBGL
    CORRADE_COMPARE(Math::pack<UnsignedLong>(0.0l), 0);
    {
        #ifdef CORRADE_MSVC2015_COMPATIBILITY
        CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015.");
        #endif
        CORRADE_COMPARE(Math::pack<UnsignedLong>(1.0l), std::numeric_limits<UnsignedLong>::max());
    }
    #endif

    CORRADE_COMPARE(Math::pack<UnsignedShort>(0.33f), 21626);
    CORRADE_COMPARE(Math::pack<UnsignedShort>(0.66f), 43253);

    /* Bits */
    CORRADE_COMPARE((Math::pack<UnsignedShort>(0.5f)), 32767);
    CORRADE_COMPARE((Math::pack<UnsignedShort, 14>(0.5f)), 8191);

    /* Vector overloads */
    CORRADE_COMPARE(Math::pack<Vector3ub>(Vector3(0.0f, 0.5f, 1.0f)), Vector3ub(0, 127, 255));
    CORRADE_COMPARE((Math::pack<Vector3ub, 6>(Vector3(0.0f, 0.5f, 1.0f))), Vector3ub(0, 31, 63));
}

void PackingTest::packSigned() {
    CORRADE_COMPARE(Math::pack<Byte>(-1.0f), -127);
    CORRADE_COMPARE(Math::pack<Byte>(-0.732f), -92);
    CORRADE_COMPARE(Math::pack<Byte>(0.0f), 0);
    CORRADE_COMPARE(Math::pack<Byte>(0.1357f), 17);
    CORRADE_COMPARE(Math::pack<Byte>(1.0f), 127);

    CORRADE_COMPARE(Math::pack<Short>(-1.0f), std::numeric_limits<Short>::min()+1);
    CORRADE_COMPARE(Math::pack<Short>(0.0f), 0);
    CORRADE_COMPARE(Math::pack<Short>(1.0f), std::numeric_limits<Short>::max());

    #ifndef MAGNUM_TARGET_GLES
    CORRADE_COMPARE(Math::pack<Int>(-1.0), std::numeric_limits<Int>::min()+1);
    CORRADE_COMPARE(Math::pack<Int>(0.0), 0);
    CORRADE_COMPARE(Math::pack<Int>(1.0), std::numeric_limits<Int>::max());

    {
        #ifdef CORRADE_MSVC2015_COMPATIBILITY
        CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015.");
        #endif
        CORRADE_COMPARE(Math::pack<Long>(-1.0l), std::numeric_limits<Long>::min()+1);
    }
    CORRADE_COMPARE(Math::pack<Long>(0.0l), 0);
    {
        #ifdef CORRADE_MSVC2015_COMPATIBILITY
        CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015.");
        #endif
        CORRADE_COMPARE(Math::pack<Long>(1.0l), std::numeric_limits<Long>::max());
    }
    #endif

    CORRADE_COMPARE(Math::pack<Short>(-0.33f), -10813);
    CORRADE_COMPARE(Math::pack<Short>(0.66f), 21626);

    /* Bits */
    CORRADE_COMPARE((Math::pack<Short>(-0.5f)), -16383);
    CORRADE_COMPARE((Math::pack<Short, 14>(-0.5f)), -4095);

    /* Vector overloads */
    CORRADE_COMPARE(Math::pack<Vector3b>(Vector3(0.0f, -1.0f, 0.5f)), Vector3b(0, -127, 63));
    CORRADE_COMPARE((Math::pack<Vector3b, 6>(Vector3(0.0f, -1.0f, 0.5f))), Vector3b(0, -31, 15));

}

void PackingTest::reunpackUnsinged() {
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedByte>(0.0f)), 0.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedByte>(1.0f)), 1.0f);

    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedShort>(0.0f)), 0.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedShort>(1.0f)), 1.0f);

    CORRADE_COMPARE(Math::unpack<Double>(Math::pack<UnsignedInt>(0.0)), 0.0);
    CORRADE_COMPARE(Math::unpack<Double>(Math::pack<UnsignedInt>(1.0)), 1.0);

    #ifndef MAGNUM_TARGET_WEBGL
    CORRADE_COMPARE(Math::unpack<long double>(Math::pack<UnsignedLong>(0.0l)), 0.0l);
    {
        #ifdef CORRADE_MSVC2015_COMPATIBILITY
        CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015.");
        #endif
        CORRADE_COMPARE(Math::unpack<long double>(Math::pack<UnsignedLong>(1.0l)), 1.0l);
    }
    #endif
}

void PackingTest::reunpackSinged() {
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(-1.0f)), -1.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(0.0f)), 0.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(1.0f)), 1.0f);

    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(-1.0f)), -1.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(0.0f)), 0.0f);
    CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(1.0f)), 1.0f);

    CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(-1.0)), -1.0);
    CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(0.0)), 0.0);
    CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(1.0)), 1.0);

    #ifndef MAGNUM_TARGET_WEBGL
    CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(-1.0l)), -1.0l);
    CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(0.0l)), 0.0l);
    {
        #ifdef CORRADE_MSVC2015_COMPATIBILITY
        CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015.");
        #endif
        CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(1.0l)), 1.0l);
    }
    #endif
}

void PackingTest::unpackTypeDeduction() {
    if(std::is_signed<char>::value)
        CORRADE_COMPARE(Math::unpack<Float>('\x7F'), 1.0f);
    else {
        /* Raspberry Pi `char` is unsigned (huh) */
        CORRADE_VERIFY(std::is_unsigned<char>::value);
        CORRADE_COMPARE(Math::unpack<Float>('\x7F'), 0.498039f);
    }
    CORRADE_COMPARE((Math::unpack<Float, Byte>('\x7F')), 1.0f);
}

}}}

CORRADE_TEST_MAIN(Magnum::Math::Test::PackingTest)