MathUtils.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_CORE_MATH_MATHUTILS_H
#define IMT_BASE_CORE_MATH_MATHUTILS_H
 
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Core.Platform/StaticClass.h>
 
#ifdef USE_STL
#include <algorithm>
#endif // USE_STL
 
namespace imt {
namespace base {
namespace core {
namespace math {
 
class MathUtils final : private ::imt::base::core::platform::StaticClass {
 
public:
 
    template<typename Type>
    static inline Type truncateToRange(Type const value, Type const minRange, Type const maxRange) noexcept {
#ifdef USE_STL
        Type const left {std::min<Type>(minRange, maxRange)};
        Type const right {std::max<Type>(minRange, maxRange)};
        return std::min<Type>(std::max<Type>(value, left), right);
#else
        if (value < minRange) {
            return minRange;
        }
        else if (value > maxRange) {
            return maxRange;
        }
        else {
            return value;
        }
#endif //USE_STL
    }
 
    template<class T>
    static inline int32_t roundToInt(T const floatToRoundToInt) noexcept {
        T const floatRounding {(floatToRoundToInt > static_cast<T>(0)) ? static_cast<T>(0.5) : static_cast<T>(-0.5)};
        // AXIVION Next Codeline AutosarC++19_03-M0.4.2: Simple addition with floats
        T const result {floatToRoundToInt + floatRounding};
        return static_cast<int32_t>(result);
    }
 
    static inline uint32_t roundToNextFive(uint32_t const value) {
        constexpr uint32_t roundTo {5U};
        return (((value + 2U) / roundTo) * roundTo);
    }
 
    template<typename Type>
    static constexpr Type map(Type const value, float32_t const fromLow, float32_t const fromHigh, float32_t const toLow, float32_t const toHigh) noexcept {
        // AXIVION Next Codeline AutosarC++19_03-M0.4.2: Scale float range to other float range and cast
        return static_cast<Type>(((((static_cast<float32_t>(value) - fromLow) * (toHigh - toLow)) / (fromHigh - fromLow)) + toLow));
    }
};
 
} // namespace math
} // namespace core
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_CORE_MATH_MATHUTILS_H