TestLine3.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_TEST_TESTMATH_LINE_3_H
#define META_OCEAN_TEST_TESTMATH_LINE_3_H
 
#include "ocean/test/testmath/TestMath.h"
 
namespace Ocean
{
 
namespace Test
{
 
namespace TestMath
{
 
/**
 * This class implements a 3D line test.
 * @ingroup testmath
 */
class OCEAN_TEST_MATH_EXPORT TestLine3
{
    public:
 
        /**
         * This functions tests all 3D line functions.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         */
        static bool test(const double testDuration);
 
        /**
         * Is on line test.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type of the scalar to use, either 'float' or 'double'
         */
        template <typename T>
        static bool testIsOnLine(const double testDuration);
 
        /**
         * Tests the nearest points function.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type of the scalar to use, either 'float' or 'double'
         */
        template <typename T>
        static bool testNearestPoints(const double testDuration);
 
        /**
         * Tests the distance function.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type of the scalar to use, either 'float' or 'double'
         */
        template <typename T>
        static bool testDistance(const double testDuration);
};
 
}
 
}
 
}
 
#endif // META_OCEAN_TEST_TESTMATH_LINE_3_H