safemath.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Safe math header file
---------------------
This file defines basic functions for safe mathematical operations.
Rather than raising an error on fail cases (i.e. divide by zero),
the following libraries are designed to check for errors and return
corresponding codes.
 
Author: Alex Reynolds
*/
 
#ifndef CORE_SAFEMATH_H
#define CORE_SAFEMATH_H
 
#include "types.h"
 
#define SAFE_MATH_ZERO_TOLERANCE 1e-15
#define SAFE_MATH_FLOAT_TOLERANCE 1e-6
 
namespace clockwerk {

    int16 safeDivide(float a, float b, float &result);
    int16 safeDivide(double a, double b, double &result);
    int16 safeDivide(int32 a, int32 b, int32 &result);
    int16 safeDivide(uint64 a, uint64 b, uint64 &result);

    int16 safeSqrt(float input, float &result);
    int16 safeSqrt(double input, double &result);

    int16 safeNroot(float input, int32 rt, float &result);
    int16 safeNroot(double input, int32 rt, double &result);

    int16 safeAcos(float input, float &result);
    int16 safeAcos(double input, double &result);

    int16 safeAsin(float input, float &result);
    int16 safeAsin(double input, double &result);

    int16 safeTan(float input, float &result);
    int16 safeTan(double input, double &result);

    bool floatEquals(floating_point a, floating_point b,
        floating_point tolerance=SAFE_MATH_FLOAT_TOLERANCE);

    int16 sgn(floating_point val);
}
 
#endif