vector3test.cpp

Go to the documentation of this file.

/*
This program is distributed under the terms of the 'MIT license'. The text
of this licence follows...

Copyright (c) 2005-2009 J.D.Medhurst (a.k.a. Tixy)

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 "common.h"
#include "test/test.h"
#include "../vector3.h"



//
// Testing helpers
//

static bool Check(bool r)
    {
    if(!r)
        {
        BREAKPOINT;
        }
    return r;
    }

static bool CheckEqual(int a,int b)
    {
    bool r = a==b;
    if(!r)
        {
        BREAKPOINT;
        }
    return r;
    }

static bool CheckEqual(const Vector3& a,const Vector3& b)
    {
    bool r = a==b;
    if(!r)
        {
        BREAKPOINT;
        }
    return r;
    }

static bool CheckNotEqual(const Vector3& a,const Vector3& b)
    {
    bool r = a!=b;
    if(!r)
        {
        BREAKPOINT;
        }
    return r;
    }

#define CHECK(c)        (void)(Check(c)||TEST_FAILED)
#define CHECK_EQ(a,b)   (void)(CheckEqual((a),(b))||TEST_FAILED)
#define CHECK_NE(a,b)   (void)(CheckNotEqual((a),(b))||TEST_FAILED)



//
// Individual test functions
//

static void TestLengthSquared()
    {
    int n;
    ufix seed=0;
    for(n=0; n<(1<<20); n++)
        {
        fix x = Fix::Random(seed);
        fix y = Fix::Random(seed);
        fix z = Fix::Random(seed);
        ufix f;
        ufix i = Vector3(x,y,z).LengthSquared(f);
        uint64_t d1 = int64_t(x)*int64_t(x)+int64_t(y)*int64_t(y)+int64_t(z)*int64_t(z);
        uint64_t d2 = uint64_t(i)*uint64_t(65536)*uint64_t(65536)+uint64_t(f);
        int64_t d = d1-d2;
        if(d<0) d = -d;
        CHECK(d1==d2);
        }
    }


static void TestLength()
    {
    int i;
    for(i=0; i<31; i++)
        {
        CHECK_EQ(Vector3(1<<i,0,0).Length(),1<<i);
        CHECK_EQ(Vector3(0,1<<i,0).Length(),1<<i);
        CHECK_EQ(Vector3(0,0,1<<i).Length(),1<<i);
        if(i<29)
            CHECK_EQ(Vector3(1<<i,4<<i,8<<i).Length(),9<<i);
        }
    for(i=0; i<(1<<24); i++)
        {
        CHECK_EQ(Vector3(i,0,0).Length(),i);
        CHECK_EQ(Vector3(0,-i,0).Length(),i);
        CHECK_EQ(Vector3(0,0,i<<1).Length(),i<<1);
        }
    ufix seed=0;
    for(i=0; i<(1<<20); i++)
        {
        fix r = Fix::Random(seed,1<<24);
        r <<= Fix::Random(seed,8);
        ufix a = r<0 ? -r : r;
        CHECK_EQ(Vector3(r,0,0).Length(),a);
        CHECK_EQ(Vector3(0,r,0).Length(),a);
        CHECK_EQ(Vector3(0,0,r).Length(),a);
        }
    }


static void TestCompareLength()
    {
    int n;
    ufix seed=0;
    for(n=0; n<(1<<20); n++)
        {
        fix x = Fix::Random(seed);
        fix y = Fix::Random(seed);
        fix z = Fix::Random(seed);
        Vector3 v(x,y,z);
        ufix l = v.Length();
        if(l<0xffffff00u)
            CHECK_EQ(v.CompareLength(l+0x100),-1);
        if(l>=0x100)
            CHECK_EQ(v.CompareLength(l-0x100),1);
        }
    for(n=0; n<(1<<20); n++)
        {
        fix r = Fix::Random(seed,1<<24);
        r <<= Fix::Random(seed,8);
        ufix a = r<0 ? -r : r;
        Vector3 v(0,a,0);
        ufix l = v.Length();
        CHECK_EQ(v.CompareLength(l),0);
        if(l<0xffffffffu)
            CHECK_EQ(v.CompareLength(l+1),-1);
        if(l>=0x1)
            CHECK_EQ(v.CompareLength(l-1),1);
        }
    }


static void TestUnitVector()
    {
    uint32_t seed = 0;
    for(int n=0; n<1<<20; n++)
        {
        fix x = Fix::Random(seed);
        fix y = Fix::Random(seed);
        fix z = Fix::Random(seed);
        Vector3 u(Vector3(x,y,z).UnitVector());

        ufix l = u.Length();
        CHECK(l<=0x10000 && l>=0x0fffe);

        ufix f;
        ufix i = u.LengthSquared(f);
        if(i)
            {
            CHECK(i==1);
            CHECK(f<0x00010000);
            }
        else
            CHECK(f>0xfffc0000);
        }

    for(int t=0; t<5; t++)
        {
        fix in[5][3] =
            {
                {0x12345678, 0, 0},
                {4<<16, 3<<16, 0},
                {1<<16, 2<<16, 2<<16},
                {1<<16, 4<<16, 8<<16},
                {1, 4, 8}
            };
        fix out[5][3] =
            {
                {1<<16, 0, 0},
                {(4<<16)/5, (3<<16)/5, 0},
                {(1<<16)/3, (2<<16)/3, (2<<16)/3},
                {(1<<16)/9, (4<<16)/9, (8<<16)/9},
                {(1<<16)/9, (4<<16)/9, (8<<16)/9}
            };
        for(int i=0; i<3; i++)
            for(int j=0; j<3; j++)
                for(int k=0; k<3; k++)
                    {
                    if(i==j) continue;
                    if(i==k) continue;
                    if(j==k) continue;
                    int a[3];
                    int b[3];
                    for(int s=0; s<8; s++)
                        {
                        a[0] = in[t][i];
                        a[1] = in[t][j];
                        a[2] = in[t][k];
                        b[0] = out[t][i];
                        b[1] = out[t][j];
                        b[2] = out[t][k];
                        if(s&1)
                            {
                            a[0] = -a[0];
                            b[0] = -b[0];
                            }
                        if(s&2)
                            {
                            a[1] = -a[1];
                            b[1] = -b[1];
                            }
                        if(s&4)
                            {
                            a[2] = -a[2];
                            b[2] = -b[2];
                            }
                        CHECK_EQ(Vector3(a[0],a[1],a[2]).UnitVector(),Vector3(b[0],b[1],b[2]));
                        }
                    }
        }
    }


static void TestNormal()
    {
    CHECK_EQ(Vector3(17<<8,0,0).Normal(Vector3(0,31<<16,0)),Vector3(0,0,1<<16));
    CHECK_EQ(Vector3(-17<<8,0,0).Normal(Vector3(0,31<<16,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(Vector3(17<<8,0,0).Normal(Vector3(0,-31<<16,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(Vector3(-17<<8,0,0).Normal(Vector3(0,-31<<16,0)),Vector3(0,0,1<<16));
    fix q = 119<<16;
    CHECK_EQ(Vector3(q,q,0).Normal(Vector3(-q,q,0)),Vector3(0,0,1<<16));
    CHECK_EQ(Vector3(-q,q,0).Normal(Vector3(q,q,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(Vector3(q,0,q).Normal(Vector3(-q,0,q)),Vector3(0,-1<<16,0));
    CHECK_EQ(Vector3(-q,0,q).Normal(Vector3(q,0,q)),Vector3(0,1<<16,0));
    CHECK_EQ(Vector3(0,q,q).Normal(Vector3(0,-q,q)),Vector3(1<<16,0,0));
    CHECK_EQ(Vector3(0,-q,q).Normal(Vector3(0,q,q)),Vector3(-1<<16,0,0));
    q = 0x7fffffff;
    CHECK_EQ(Vector3(q,q,0).Normal(Vector3(-q,q,0)),Vector3(0,0,1<<16));
    CHECK_EQ(Vector3(-q,q,0).Normal(Vector3(q,q,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(Vector3(q,0,q).Normal(Vector3(-q,0,q)),Vector3(0,-1<<16,0));
    CHECK_EQ(Vector3(-q,0,q).Normal(Vector3(q,0,q)),Vector3(0,1<<16,0));
    CHECK_EQ(Vector3(0,q,q).Normal(Vector3(0,-q,q)),Vector3(1<<16,0,0));
    CHECK_EQ(Vector3(0,-q,q).Normal(Vector3(0,q,q)),Vector3(-1<<16,0,0));

    int i;
    for(i=0; i<31; i++)
        for(int j=0; j<31; j++)
            {
            CHECK_EQ(Vector3(1<<i,0,0).Normal(Vector3(0,1<<j,0)),Vector3(0,0,1<<16));
            CHECK_EQ(Vector3((1<<(i+1))-1,0,0).Normal(Vector3(0,(1<<(j+1))-1,0)),Vector3(0,0,1<<16));
            CHECK_EQ(Vector3(0,-1<<i,0).Normal(Vector3(0,0,1<<j)),Vector3(-1<<16,0,0));
            CHECK_EQ(Vector3(0,-1<<(i+1),0).Normal(Vector3(0,0,1<<j)),Vector3(-1<<16,0,0));
            CHECK_EQ(Vector3(0,-1<<(i+1),0).Normal(Vector3(0,0,(1<<(j+1))-1)),Vector3(-1<<16,0,0));
            }

    uint32_t seed=0;
    for(i=0; i<1<<20; i++)
        {
        ufix a = Fix::Random(seed);
        ufix b = Fix::Random(seed);
        Vector3 n(Vector3(1|(a>>1),0,0).Normal(Vector3(0,1|(b>>1),0)));
        CHECK_EQ(n,Vector3(0,0,1<<16));
        }

    for(i=0; i<1<<20; i++)
        {
        Vector3 a(Fix::Random(seed),Fix::Random(seed),Fix::Random(seed));
        Vector3 b(Fix::Random(seed),Fix::Random(seed),Fix::Random(seed));
        Vector3 n(a.Normal(b));
        fix l = n.Length();
        CHECK(l<=0x10000 && l>=0x0fffe);
        }
    }


#define OFFSET_VECTOR(a,b,c) Vector3((a)+(1<<16),(b)+(2<<16),(c)+(3<<16))

static void TestPointNormal()
    {
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(17<<8,0,0),OFFSET_VECTOR(0,31<<16,0)),Vector3(0,0,1<<16));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(-17<<8,0,0),OFFSET_VECTOR(0,31<<16,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(17<<8,0,0),OFFSET_VECTOR(0,-31<<16,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(-17<<8,0,0),OFFSET_VECTOR(0,-31<<16,0)),Vector3(0,0,1<<16));
    fix q = 119<<16;
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(q,q,0),OFFSET_VECTOR(-q,q,0)),Vector3(0,0,1<<16));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(-q,q,0),OFFSET_VECTOR(q,q,0)),Vector3(0,0,-1<<16));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(q,0,q),OFFSET_VECTOR(-q,0,q)),Vector3(0,-1<<16,0));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(-q,0,q),OFFSET_VECTOR(q,0,q)),Vector3(0,1<<16,0));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(0,q,q),OFFSET_VECTOR(0,-q,q)),Vector3(1<<16,0,0));
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Normal(OFFSET_VECTOR(0,-q,q),OFFSET_VECTOR(0,q,q)),Vector3(-1<<16,0,0));
    }


static void TestAngle()
    {
    CHECK_EQ(Vector3(1,0,0).Angle(Vector3(0,1,0)),0x4000);
    CHECK_EQ(Vector3(0,-1,0).Angle(Vector3(0,0,1)),0x4000);
    CHECK_EQ(Vector3(1,1,0).Angle(Vector3(-1,1,0)),0x4000);

    CHECK_EQ(Vector3(1,0,0).Angle(Vector3(1,0,0)),0);
    CHECK(Vector3(1,1,0).Angle(Vector3(1,1,0))<0x80);
    CHECK_EQ(Vector3(0,1,0).Angle(Vector3(1,1,0)),0x2000);

    CHECK_EQ(Vector3(1,0,0).Angle(Vector3(-1,0,0)),0x8000);
    CHECK(Vector3(1,1,0).Angle(Vector3(-1,-1,0))>0x7f80);
    CHECK(Vector3(0,-1,1).Angle(Vector3(0,1,-1))>0x7f80);
    }


static void TestPointAngle()
    {
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,0,0),OFFSET_VECTOR(0,1,0)),0x4000);
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(0,-1,0),OFFSET_VECTOR(0,0,1)),0x4000);
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,1,0),OFFSET_VECTOR(-1,1,0)),0x4000);

    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,0,0),OFFSET_VECTOR(1,0,0)),0);
    CHECK(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,1,0),OFFSET_VECTOR(1,1,0))<0x80);
    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(0,1,0),OFFSET_VECTOR(1,1,0)),0x2000);

    CHECK_EQ(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,0,0),OFFSET_VECTOR(-1,0,0)),0x8000);
    CHECK(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(1,1,0),OFFSET_VECTOR(-1,-1,0))>0x7f80);
    CHECK(OFFSET_VECTOR(0,0,0).Angle(OFFSET_VECTOR(0,-1,1),OFFSET_VECTOR(0,1,-1))>0x7f80);
    }


static void TestTranslate()
    {
    Vector3 in[3];
    in[0] = Vector3(10,20,30);
    in[1] = Vector3(100,200,300);
    in[2] = Vector3(1000,2000,3000);
    Vector3 out[3];
    out[0] = in[0];
    out[1] = in[1];
    out[2] = in[2];
    Vector3 offset(1,2,3);

    Vector3::Translate(out,0,in,offset);
    CHECK_EQ(out[0],in[0]);

    Vector3::Translate(out,2,in,offset);
    CHECK_EQ(out[0],Vector3(11,22,33));
    CHECK_EQ(out[1],Vector3(101,202,303));
    CHECK_EQ(out[2],in[2]);
    }


static void TestScale()
    {
    Vector3 in[3];
    in[0] = Vector3(10,20,30);
    in[1] = Vector3(100,200,300);
    in[2] = Vector3(1000,2000,3000);
    Vector3 out[3];
    out[0] = in[0];
    out[1] = in[1];
    out[2] = in[2];
    Vector3::Scale(out,0,in,2<<16);
    CHECK_EQ(out[0],in[0]);
    Vector3::Scale(out,2,in,2<<16);
    CHECK_EQ(out[0],Vector3(20,40,60));
    CHECK_EQ(out[1],Vector3(200,400,600));
    CHECK_EQ(out[2],in[2]);
    }


static void TestMatrix3()
    {
    // test Matrix3 constructor
    Vector3 r1(1,2,3);
    Vector3 r2(4,5,6);
    Vector3 r3(7,8,9);
    Matrix3 m(r1,r2,r3);
    CHECK(m.Row1==r1);
    CHECK(m.Row2==r2);
    CHECK(m.Row3==r3);

    // test Tranposition
    Matrix3 tm(m.Transposition());
    CHECK(tm.Row1==Vector3(1,4,7));
    CHECK(tm.Row2==Vector3(2,5,8));
    CHECK(tm.Row3==Vector3(3,6,9));

    // test Matrix multiplication
    fix o = 1<<16;
    Vector3 a;
    a = Matrix3(Vector3(o,0,0),Vector3(0,o,0),Vector3(0,0,o))*r1;
    CHECK_EQ(a,Vector3(1,2,3));
    a = Matrix3(Vector3(0,o,0),Vector3(0,0,o),Vector3(o,0,0))*r1;
    CHECK_EQ(a,Vector3(2,3,1));
    a = Matrix3(Vector3(0,0,o),Vector3(o,0,0),Vector3(0,o,0))*r1;
    CHECK_EQ(a,Vector3(3,1,2));
    a = Matrix3(Vector3(o,-o,0),Vector3(0,0,0),Vector3(0,0,0))*r1;
    CHECK_EQ(a,Vector3(-1,0,0));
    a = Matrix3(Vector3(0,0,0),Vector3(o,0,-o),Vector3(0,0,0))*r1;
    CHECK_EQ(a,Vector3(0,-2,0));
    a = Matrix3(Vector3(0,0,0),Vector3(0,0,0),Vector3(0,-o,o))*r1;
    CHECK_EQ(a,Vector3(0,0,1));
    o = -o;
    a = Matrix3(Vector3(o,0,0),Vector3(0,o,0),Vector3(0,0,o))*r1;
    CHECK_EQ(a,Vector3(-1,-2,-3));
    a = Matrix3(Vector3(0,o,0),Vector3(0,0,o),Vector3(o,0,0))*r1;
    CHECK_EQ(a,Vector3(-2,-3,-1));
    a = Matrix3(Vector3(0,0,o),Vector3(o,0,0),Vector3(0,o,0))*r1;
    CHECK_EQ(a,Vector3(-3,-1,-2));

    // test Transform
    Vector3 in[3];
    in[0] = Vector3(10,20,30);
    in[1] = Vector3(100,200,300);
    in[2] = Vector3(1000,2000,3000);
    Vector3 out[3];
    out[0] = in[0];
    out[1] = in[1];
    out[2] = in[2];
    Vector3 offset(1,2,3);

    m = Matrix3(Vector3(2<<16,0,0),Vector3(0,-1<<16,0),Vector3(0,0,3<<16));
    m.Transform(out,0,in);
    CHECK_EQ(out[0],in[0]);

    m.Transform(out,2,in);
    CHECK_EQ(out[0],Vector3(20,-20,90));
    CHECK_EQ(out[1],Vector3(200,-200,900));
    CHECK_EQ(out[2],in[2]);
    }



//
// Top level test function
//

void TestVector3()
    {
    TestNormal();

    Vector3 a(1,2,3);
    Vector3 b(110,-220,330);
    Vector3 c;

    // test equality operator
    CHECK_EQ(a,a);
    CHECK_EQ(a,Vector3(1,2,3));

    // test inequality operator
    CHECK_NE(a,Vector3(2,2,3));
    CHECK_NE(a,Vector3(1,3,3));
    CHECK_NE(a,Vector3(1,2,2));

    // test uninary minus
    CHECK_EQ(-a,Vector3(-1,-2,-3));

    // test addition
    CHECK_EQ(a+b,Vector3(111,-218,333));
    CHECK_EQ(b+a,Vector3(111,-218,333));
    c=a;
    CHECK_EQ((c+=b),Vector3(111,-218,333));

    // test subtraction
    CHECK_EQ(a-b,Vector3(-109,222,-327));
    CHECK_EQ(b-a,Vector3(109,-222,327));
    c=a;
    CHECK_EQ((c-=b),Vector3(-109,222,-327));

    // test scalar multiply
    CHECK_EQ(a*(-10<<16),Vector3(-10,-20,-30));
    CHECK_EQ(a*(10<<16),Vector3(10,20,30));
    c=a;
    CHECK_EQ((c*=(-10<<16)),Vector3(-10,-20,-30));
    c=a;
    CHECK_EQ((c*=(10<<16)),Vector3(10,20,30));

    // test scalar division
    CHECK_EQ(b/(10<<16),Vector3(11,-22,33));
    CHECK_EQ(b/(-10<<16),Vector3(-11,22,-33));
    c=b;
    CHECK_EQ((c/=(10<<16)),Vector3(11,-22,33));
    c=b;
    CHECK_EQ((c/=(-10<<16)),Vector3(-11,22,-33));

    TestLengthSquared();    // test LengthSquared (also tested by tests for Length)
    TestLength();

    // test CompareLengths
    CHECK_EQ(a.CompareLengths(b),-1);
    CHECK_EQ(a.CompareLengths(a),0);
    CHECK_EQ(b.CompareLengths(a),1);
    c=b;
    c.X+=1<<16;
    CHECK_EQ(b.CompareLengths(c),-1);
    CHECK_EQ(b.CompareLengths(b),0);
    CHECK_EQ(c.CompareLengths(b),1);

    TestCompareLength();
    TestUnitVector();

    // test DotProduct
    a = Vector3(1<<16,2<<16,3<<16);
    b = Vector3(5<<16,7<<16,11<<16);
    CHECK_EQ(a.DotProduct(b),(1*5+2*7+3*11)<<16);

    // test CrossProduct
    CHECK_EQ(a.CrossProduct(b),Vector3((2*11- 3*7)<<16, (3*5 - 1*11)<<16, (1*7 - 2*5)<<16 ));

    TestNormal();
    TestAngle();
    TestPointNormal();
    TestPointAngle();
    TestTranslate();
    TestScale();
    TestMatrix3();
    }