/* Copyright 2018 The OpenXLA Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/

#ifndef XLA_ERROR_SPEC_H_
#define XLA_ERROR_SPEC_H_

#include "xla/xla_data.pb.h"

namespace xla {

// Structure describing permissible absolute and relative error bounds.
struct ErrorSpec {
  explicit constexpr ErrorSpec(double aabs, double arel = 0,
                               bool relaxed_nans = false)
      : abs(aabs), rel(arel), relaxed_nans(relaxed_nans) {}

  double abs;  // Absolute error bound.
  double rel;  // Relative error bound.

  // If relaxed_nans is true then any result is valid if we are expecting NaNs.
  // In effect, this allows the tested operation to produce incorrect results
  // for inputs outside its mathematical domain.
  bool relaxed_nans;

  // If true, then we don't check for bitwise equality of NaNs.  All NaNs are
  // considered equivalent.
  bool all_nans_are_equivalent = true;

  // If this is true, then we treat each +/-inf in the actual result as
  // equivalent to our choice of either +/-inf or the min/max floating-point
  // value.
  //
  // If the expected result is +/-inf, the actual result must still be +/-inf.
  //
  // In effect, this allows the tested operation to overflow, so long as it's
  // overflowing on "large" values.
  //
  // (We could have a symmetric more_infs_ok flag if necessary; right now it
  // appears not to be.)
  bool fewer_infs_ok = false;

  struct LowPrecisionFPErrorSpec {
    // Type of low precision floating point to use for error bound calculations.
    // We can't infer this type from the result because the lower precision
    // could have been used for intermediate calculations.
    PrimitiveType type = PrimitiveType::PRIMITIVE_TYPE_INVALID;
    // Allowable distance in number of representable floats between the expected
    // and actual once they're converted to the PrimitiveType specified above.
    // Note:
    // - this is only valid if the expected value is outside the error bound.
    // - +/-0 are considered equivalent.
    int within_n_values = -1;
  };

  // If the computation uses low precision floating point (e.g. FP8), this field
  // specifies the error bounds to be used. This allows us to have a per element
  // error bound measured in floats vs relying on the default relative/absolute
  // error bounds. We need this for FP8 since it's very sparse and we'd like to
  // avoid unnecessarily large error bounds. This overrides abserr/relerr when
  // specified.
  LowPrecisionFPErrorSpec low_precision_fp_error_spec;
};

}  // namespace xla

#endif  // XLA_ERROR_SPEC_H_