Files
o3de/Gems/EMotionFX/Code/MCore/Source/Compare.h
T
Steve Pham b4a2edec6a Final update copyright headers to reference license files at the repo root (#1693)
* Final update copyright headers to reference license files at the repo root

Signed-off-by: spham <spham@amazon.com>

* Fix copyright validator unit tests to support the stale O3DE header scenario

Signed-off-by: spham <spham@amazon.com>
2021-06-30 19:51:55 -07:00

42 lines
1.3 KiB
C++

/*
* Copyright (c) Contributors to the Open 3D Engine Project. For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#pragma once
// include the required headers
#include "StandardHeaders.h"
#include <AzCore/Math/Vector2.h>
#include <MCore/Source/AzCoreConversions.h>
namespace MCore
{
/**
* The class used to check differences between given objects. The differences are all represented as floats.
* This class can be useful in some specific algorithms used for optimizing data sets.
* Partial template specialization is used to calculate differences between custom object types.
* There is already support provided for a number of types, such as floats, ints and vectors.
*/
template <class T>
class Compare
{
public:
/**
* Check if two given values are close to eachother or not.
* @param a The first value.
* @param b The second value.
* @param threshold The maximum error threshold value.
* @note Partial template specialization MUST be used to define behavior for the given type.
*/
static MCORE_INLINE bool CheckIfIsClose(const T& a, const T& b, float threshold);
};
// include the inline code
#include "Compare.inl"
}