base::internal::CheckedNumeric< T > Class Template Reference

#include <checked_math.h>

Public Types
using	type = T

Public Member Functions
constexpr	CheckedNumeric ()=default
template<typename Src >
constexpr	CheckedNumeric (const CheckedNumeric< Src > &rhs)
template<typename Src >
constexpr	CheckedNumeric (Src value)
template<typename Src >
constexpr	CheckedNumeric (StrictNumeric< Src > value)
template<typename Dst = T>
constexpr bool	IsValid () const
template<typename Dst >
constexpr bool	AssignIfValid (Dst *result) const
template<typename Dst = T, class CheckHandler = CheckOnFailure>
constexpr StrictNumeric< Dst >	ValueOrDie () const
template<typename Dst = T, typename Src >
constexpr StrictNumeric< Dst >	ValueOrDefault (const Src default_value) const
template<typename Dst >
constexpr CheckedNumeric< typename UnderlyingType< Dst >::type >	Cast () const
template<typename Src >
constexpr CheckedNumeric &	operator+= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator-= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator*= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator/= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator%= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator<<= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator>>= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator&= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator|= (const Src rhs)
template<typename Src >
constexpr CheckedNumeric &	operator^= (const Src rhs)
constexpr CheckedNumeric	operator- () const
constexpr CheckedNumeric	operator~ () const
constexpr CheckedNumeric	Abs () const
template<typename U >
constexpr CheckedNumeric< typename MathWrapper< CheckedMaxOp, T, U >::type >	Max (const U rhs) const
template<typename U >
constexpr CheckedNumeric< typename MathWrapper< CheckedMinOp, T, U >::type >	Min (const U rhs) const
constexpr CheckedNumeric< typename UnsignedOrFloatForSize< T >::type >	UnsignedAbs () const
constexpr CheckedNumeric &	operator++ ()
constexpr CheckedNumeric	operator++ (int)
constexpr CheckedNumeric &	operator-- ()
constexpr CheckedNumeric	operator-- (int)
template<template< typename, typename, typename > class M, typename R >
constexpr CheckedNumeric &	MathOp (const R rhs)

Static Public Member Functions
template<template< typename, typename, typename > class M, typename L , typename R >
static constexpr CheckedNumeric	MathOp (const L lhs, const R rhs)

Friends
template<typename Src >
class	CheckedNumeric
template<typename U >
U	GetNumericValueForTest (const CheckedNumeric< U > &src)

Detailed Description

template<typename T>
class base::internal::CheckedNumeric< T >

Definition at line 18 of file checked_math.h.

Member Typedef Documentation

type

template<typename T >

using base::internal::CheckedNumeric< T >::type = T

Definition at line 23 of file checked_math.h.

Constructor & Destructor Documentation

CheckedNumeric() [1/4]

template<typename T >

constexpr base::internal::CheckedNumeric< T >::CheckedNumeric ( )

constexprdefault

CheckedNumeric() [2/4]

template<typename T >

template<typename Src >

constexpr base::internal::CheckedNumeric< T >::CheckedNumeric ( const CheckedNumeric< Src > &  rhs )

inlineconstexpr

Definition at line 29 of file checked_math.h.

      : state_(rhs.state_.value(), rhs.IsValid()) {}

CheckedNumeric() [3/4]

template<typename T >

template<typename Src >

constexpr base::internal::CheckedNumeric< T >::CheckedNumeric ( Src  value )

inlineconstexpr

Definition at line 38 of file checked_math.h.

      : state_(value) {
    static_assert(std::is_arithmetic<Src>::value, "Argument must be numeric.");
  }

CheckedNumeric() [4/4]

template<typename T >

template<typename Src >

constexpr base::internal::CheckedNumeric< T >::CheckedNumeric ( StrictNumeric< Src >  value )

inlineconstexpr

Definition at line 46 of file checked_math.h.

      : state_(static_cast<Src>(value)) {}

Member Function Documentation

Abs()

template<typename T >

constexpr CheckedNumeric base::internal::CheckedNumeric< T >::Abs ( ) const

inlineconstexpr

Definition at line 159 of file checked_math.h.

                                       {
    return !IsValueNegative(state_.value()) ? *this : -*this;
  }

AssignIfValid()

template<typename T >

template<typename Dst >

constexpr bool base::internal::CheckedNumeric< T >::AssignIfValid ( Dst *  result ) const

inlineconstexpr

Definition at line 69 of file checked_math.h.

                                   {
    return BASE_NUMERICS_LIKELY(IsValid<Dst>())
               ? ((*result = static_cast<Dst>(state_.value())), true)
               : false;
  }

Cast()

template<typename T >

template<typename Dst >

constexpr CheckedNumeric< typename UnderlyingType< Dst >::type > base::internal::CheckedNumeric< T >::Cast ( ) const

inlineconstexpr

Definition at line 107 of file checked_math.h.

                                                                          {
    return *this;
  }

IsValid()

template<typename T >

template<typename Dst = T>

constexpr bool base::internal::CheckedNumeric< T >::IsValid ( ) const

inlineconstexpr

Definition at line 54 of file checked_math.h.

                                 {
    return state_.is_valid() &&
           IsValueInRangeForNumericType<Dst>(state_.value());
  }

MathOp() [1/2]

template<typename T >

template<template< typename, typename, typename > class M, typename L , typename R >

static constexpr CheckedNumeric base::internal::CheckedNumeric< T >::MathOp ( const L  lhs, const R  rhs  )

inlinestaticconstexpr

Definition at line 229 of file checked_math.h.

                                                                   {
    using Math = typename MathWrapper<M, L, R>::math;
    T result = 0;
    bool is_valid =
        Wrapper<L>::is_valid(lhs) && Wrapper<R>::is_valid(rhs) &&
        Math::Do(Wrapper<L>::value(lhs), Wrapper<R>::value(rhs), &result);
    return CheckedNumeric<T>(result, is_valid);
  }

MathOp() [2/2]

template<typename T >

template<template< typename, typename, typename > class M, typename R >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::MathOp ( const R  rhs )

inlineconstexpr

Definition at line 240 of file checked_math.h.

                                                {
    using Math = typename MathWrapper<M, T, R>::math;
    T result = 0;  // Using T as the destination saves a range check.
    bool is_valid = state_.is_valid() && Wrapper<R>::is_valid(rhs) &&
                    Math::Do(state_.value(), Wrapper<R>::value(rhs), &result);
    *this = CheckedNumeric<T>(result, is_valid);
    return *this;
  }

Max()

template<typename T >

template<typename U >

constexpr CheckedNumeric< typename MathWrapper< CheckedMaxOp, T, U >::type > base::internal::CheckedNumeric< T >::Max ( const U  rhs ) const

inlineconstexpr

Definition at line 164 of file checked_math.h.

                         {
    using R = typename UnderlyingType<U>::type;
    using result_type = typename MathWrapper<CheckedMaxOp, T, U>::type;
    // TODO(jschuh): This can be converted to the MathOp version and remain
    // constexpr once we have C++14 support.
    return CheckedNumeric<result_type>(
        static_cast<result_type>(
            IsGreater<T, R>::Test(state_.value(), Wrapper<U>::value(rhs))
                ? state_.value()
                : Wrapper<U>::value(rhs)),
        state_.is_valid() && Wrapper<U>::is_valid(rhs));
  }

Min()

template<typename T >

template<typename U >

constexpr CheckedNumeric< typename MathWrapper< CheckedMinOp, T, U >::type > base::internal::CheckedNumeric< T >::Min ( const U  rhs ) const

inlineconstexpr

Definition at line 179 of file checked_math.h.

                         {
    using R = typename UnderlyingType<U>::type;
    using result_type = typename MathWrapper<CheckedMinOp, T, U>::type;
    // TODO(jschuh): This can be converted to the MathOp version and remain
    // constexpr once we have C++14 support.
    return CheckedNumeric<result_type>(
        static_cast<result_type>(
            IsLess<T, R>::Test(state_.value(), Wrapper<U>::value(rhs))
                ? state_.value()
                : Wrapper<U>::value(rhs)),
        state_.is_valid() && Wrapper<U>::is_valid(rhs));
  }

operator%=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator%= ( const Src  rhs )

constexpr

operator&=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator&= ( const Src  rhs )

constexpr

operator*=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator*= ( const Src  rhs )

constexpr

operator++() [1/2]

template<typename T >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator++ ( )

inlineconstexpr

Definition at line 202 of file checked_math.h.

                                         {
    *this += 1;
    return *this;
  }

operator++() [2/2]

template<typename T >

constexpr CheckedNumeric base::internal::CheckedNumeric< T >::operator++ ( int  )

inlineconstexpr

Definition at line 207 of file checked_math.h.

                                           {
    CheckedNumeric value = *this;
    *this += 1;
    return value;
  }

operator+=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator+= ( const Src  rhs )

constexpr

operator-()

template<typename T >

constexpr CheckedNumeric base::internal::CheckedNumeric< T >::operator- ( ) const

inlineconstexpr

Definition at line 139 of file checked_math.h.

                                             {
    // The negation of two's complement int min is int min, so we simply
    // check for that in the constexpr case.
    // We use an optimized code path for a known run-time variable.
    return MustTreatAsConstexpr(state_.value()) || !std::is_signed<T>::value ||
                   std::is_floating_point<T>::value
               ? CheckedNumeric<T>(
                     NegateWrapper(state_.value()),
                     IsValid() && (!std::is_signed<T>::value ||
                                   std::is_floating_point<T>::value ||
                                   NegateWrapper(state_.value()) !=
                                       std::numeric_limits<T>::lowest()))
               : FastRuntimeNegate();
  }

operator--() [1/2]

template<typename T >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator-- ( )

inlineconstexpr

Definition at line 213 of file checked_math.h.

                                         {
    *this -= 1;
    return *this;
  }

operator--() [2/2]

template<typename T >

constexpr CheckedNumeric base::internal::CheckedNumeric< T >::operator-- ( int  )

inlineconstexpr

Definition at line 218 of file checked_math.h.

                                           {
    CheckedNumeric value = *this;
    *this -= 1;
    return value;
  }

operator-=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator-= ( const Src  rhs )

constexpr

operator/=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator/= ( const Src  rhs )

constexpr

operator<<=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator<<= ( const Src  rhs )

constexpr

operator>>=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator>>= ( const Src  rhs )

constexpr

operator^=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator^= ( const Src  rhs )

constexpr

operator|=()

template<typename T >

template<typename Src >

constexpr CheckedNumeric & base::internal::CheckedNumeric< T >::operator|= ( const Src  rhs )

constexpr

operator~()

template<typename T >

constexpr CheckedNumeric base::internal::CheckedNumeric< T >::operator~ ( ) const

inlineconstexpr

Definition at line 154 of file checked_math.h.

                                             {
    return CheckedNumeric<decltype(InvertWrapper(T()))>(
        InvertWrapper(state_.value()), IsValid());
  }

UnsignedAbs()

template<typename T >

constexpr CheckedNumeric< typename UnsignedOrFloatForSize< T >::type > base::internal::CheckedNumeric< T >::UnsignedAbs ( ) const

inlineconstexpr

Definition at line 197 of file checked_math.h.

                      {
    return CheckedNumeric<typename UnsignedOrFloatForSize<T>::type>(
        SafeUnsignedAbs(state_.value()), state_.is_valid());
  }

ValueOrDefault()

template<typename T >

template<typename Dst = T, typename Src >

constexpr StrictNumeric< Dst > base::internal::CheckedNumeric< T >::ValueOrDefault ( const Src  default_value ) const

inlineconstexpr

Definition at line 97 of file checked_math.h.

                                                                             {
    return BASE_NUMERICS_LIKELY(IsValid<Dst>())
               ? static_cast<Dst>(state_.value())
               : checked_cast<Dst>(default_value);
  }

ValueOrDie()

template<typename T >

template<typename Dst = T, class CheckHandler = CheckOnFailure>

constexpr StrictNumeric< Dst > base::internal::CheckedNumeric< T >::ValueOrDie ( ) const

inlineconstexpr

Definition at line 84 of file checked_math.h.

                                                  {
    return BASE_NUMERICS_LIKELY(IsValid<Dst>())
               ? static_cast<Dst>(state_.value())
               : CheckHandler::template HandleFailure<Dst>();
  }

Friends And Related Function Documentation

CheckedNumeric

template<typename T >

template<typename Src >

friend class CheckedNumeric

friend

Definition at line 33 of file checked_math.h.

GetNumericValueForTest

template<typename T >

template<typename U >

U GetNumericValueForTest ( const CheckedNumeric< U > &  src )

friend

---

The documentation for this class was generated from the following file:

• third_party/accessibility/base/numerics/checked_math.h