sc/inc/math.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <formula/errorcodes.hxx>
  23
  24 namespace sc {
  25
  26 /** Return fNumerator/fDenominator if fDenominator!=0 else #DIV/0! error coded
  27     into double.
  28  */
  29 inline double div( const double& fNumerator, const double& fDenominator )
  30 {
  31     return (fDenominator != 0.0) ? (fNumerator / fDenominator) :
  32         CreateDoubleError( FormulaError::DivisionByZero);
  33 }
  34
  35 /** Return fNumerator/fDenominator if fDenominator!=0 else +-Infinity if
  36     fNumerator!=0 or NaN if fNumerator==0.
  37
  38     This allows to build/run with -fsanitize=float-divide-by-zero and have a
  39     defined behavior for the otherwise undefined division by zero case ("If the
  40     second operand of / or % is zero the behavior is undefined."
  41     ([expr.mul]/4)).
  42
  43     The Calc interpreter gracefully handles Infinity or NaN double values
  44     encountered as interim or final results, using this function we can ensure
  45     defined behavior where desired.
  46
  47     Use where the double coded error creating div() is not wanted.
  48  */
  49 inline double divide( const double& fNumerator, const double& fDenominator )
  50 {
  51     if (fDenominator == 0.0)
  52     {
  53         if (std::isfinite( fNumerator) && fNumerator != 0.0)
  54             return std::signbit(fNumerator) ? -std::numeric_limits<double>::infinity()
  55                                             :  std::numeric_limits<double>::infinity();
  56         return std::numeric_limits<double>::quiet_NaN();
  57     }
  58     return fNumerator / fDenominator;
  59 }
  60
  61 /** Return pow(fVal1,fVal2) with error handling.
  62
  63     If an error was detected, a coded double error of
  64     FormulaError::IllegalFPOperation is returned.
  65  */
  66 double power( const double& fVal1, const double& fVal2 );
  67
  68 }
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */