Inheritance diagram for xtd::box_floating_point< type_t >:

Definition

template<typename type_t>
requires xtd::real<type_t>
class xtd::box_floating_point< type_t >

Represents a boxed floating point object.

class box_floating_point : public xtd::box<type_t>

xtd::box_floating_point

Represents a boxed floating point object.

Definition box_floating_point.hpp:42

xtd::box

Represents a boxed object.

Definition box.hpp:56

Inheritance: xtd::object → xtd::box <type_t> → xtd::box <type_t> → box_floating_point <type_t>

Header: #include <xtd/box_floating_point>

Namespace: xtd

Library: xtd.core

Remarks: You can use xtd::box to represent a class or structure that does not inherit from xtd::object. Typically used for integral types.; Use xtd::boxing to box an object.; Use xtd::unboxing to unbox an object.; For more information about types, see Native types, boxing and unboxing.

Examples: The following example shows how to create and use xtd::box_floating_point<float>.
auto stringer = [](const object& value) {return value.to_string();};

float unboxed_object = 3.14f;

box_floating_point<float> boxed_object = unboxed_object;

auto result = stringer(boxed_object);

console::write_line("result = {}", result); // Display: result = 3.14;

xtd::console::write_line
static auto write_line() -> void
Writes the current line terminator to the standard output stream using the specified format informati...

xtd::box::value
value_type value
Gets or sets the underlying value.
Definition box.hpp:106

Public Fields
static constexpr type_t	epsilon
	Represents the smallest positive type_t value greater than zero. This field is constant.
static constexpr type_t	max_value
	Represents the largest possible value of type_t. This field is constant.
static constexpr type_t	min_value
	Represents the smallest possible value of type_t. This field is constant.
static constexpr type_t	NaN
	Represents not a number (NaN). This field is constant.
static constexpr type_t	negative_infinity
	Represents negative infinity. This field is constant.
static constexpr type_t	positive_infinity
	Represents positive infinity. This field is constant.

Public Static Methods
static auto	is_finite (type_t value) noexcept -> bool
	Determines whether the specified value is finite (zero, subnormal, or normal).
static auto	is_infinity (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to negative or positive infinity.
static auto	is_NaN (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to not a number.
static auto	is_negative_infinity (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to negative infinity.
static auto	is_normal (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to normal, i.e. not an infinity, subnormal, not-a-number or zero.
static auto	is_positive_infinity (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to positive infinity.
static auto	is_subnormal (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to subnormal.
static auto	is_valid (type_t value) noexcept -> bool
	Determines whether the specified value can be safely converted to type_t without overflow.
static auto	is_zero (type_t value) noexcept -> bool
	Returns a value indicating whether the specified number evaluates to zero.
static auto	parse (const xtd::string &value, xtd::number_styles styles) -> type_t
	Converts the string to its type_t equivalent.
static auto	try_parse (const xtd::string &value, type_t &result, xtd::number_styles styles) noexcept -> bool
	Converts the string to its type_t equivalent.

Additional Inherited Members
using	value_type
	Represents the value type.
using	reference
	Represents the reference type.
using	const_reference
	Represents the cont reference type.
using	pointer
	Represents the reference type.
using	const_pointer
	Represents the cont reference type.
value_type	value
	Gets or sets the underlying value.
	box ()=default
	Initialize a new xtd::box object.
	box (const_reference value)
	Initialize a new xtd::box object with specified value.
template<typename ... args_t>
	box (args_t &&...args)
	Initialize a new xtd::box object with specified value.
	operator value_type () const noexcept
	Cast operator to the value type.
auto	compare_to (const box &value) const noexcept -> xtd::int32 override
	Compares the current instance with another object of the same type.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const box &value) const noexcept -> bool override
	Indicates whether the current object is equal to another object of the same type.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.
auto	to_string (const xtd::string &format) const -> xtd::string
	Converts the value of this instance to its equivalent string representation, using the specified format.
auto	to_string (const xtd::string &format, const globalization::culture_info &culture) const -> xtd::string override
	Converts the value of this instance to its equivalent string representation, using the specified format, and locale.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual int32	compare_to (const type_t &obj) const noexcept=0
	Compares the current instance with another object of the same type.
virtual bool	equals (const type_t &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
static auto	parse (const xtd::string &value) -> value_type
	Converts the string to its value_type equivalent.
static auto	try_parse (const xtd::string &value, reference result) noexcept -> bool
	Converts the string to its value_type equivalent. A return value indicates whether the conversion succeeded or failed.
template<typename object_a_t, typename object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Function Documentation

◆ is_finite()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_finite ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Determines whether the specified value is finite (zero, subnormal, or normal).

Parameters

value A floating-point number.

Returns: true if the value is finite (zero, subnormal or normal); false otherwise.

◆ is_infinity()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_infinity ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to negative or positive infinity.

Parameters

value A floating-point number.

Returns: true if value evaluates to xtd::math::positive_infinity or xtd::math::negative_infinity; otherwise, false.

◆ is_NaN()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_NaN ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to not a number.

Parameters

value A floating-point number.

Returns: true if value evaluates to not a number; otherwise, false.

◆ is_negative_infinity()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_negative_infinity ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to negative infinity.

Parameters

value A floating-point number.

Returns: true if value evaluates to xtd::math::negative_infinity; otherwise, false.

◆ is_normal()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_normal ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to normal, i.e. not an infinity, subnormal, not-a-number or zero.

Parameters

value A floating-point number.

Returns: true if value evaluates to normal; otherwise, false.

◆ is_positive_infinity()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_positive_infinity ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to positive infinity.

Parameters

value A floating-point number.

Returns: true if value evaluates to xtd::math::positive_infinity; otherwise, false.

◆ is_subnormal()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_subnormal ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to subnormal.

Parameters

value A floating-point number.

Returns: true if value evaluates to subnormal; otherwise, false.

◆ is_valid()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_valid ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Determines whether the specified value can be safely converted to type_t without overflow.

Parameters

value The floating point value to validate.

Returns: true if value is greater than or equal to min_value and less than or equal to max_value; otherwise, false.

Remarks: If the value is outside the valid range defined by min_value and max_value, the method returns false.

◆ is_zero()

template<typename type_t>

auto xtd::box_floating_point< type_t >::is_zero ( type_t value ) -> bool

inlinestaticnodiscardnoexcept

Returns a value indicating whether the specified number evaluates to zero.

Parameters

value A floating-point number.

Returns: true if value evaluates to zero; otherwise, false.

◆ parse()

template<typename type_t>

auto xtd::box_floating_point< type_t >::parse	(	const xtd::string &	value,
		xtd::number_styles	styles ) -> type_t

inlinestaticnodiscard

Converts the string to its type_t equivalent.

Parameters

value A string containing a type_t to convert.

Returns: A type_t equivalent to the number contained in value.

◆ try_parse()

template<typename type_t>

auto xtd::box_floating_point< type_t >::try_parse	(	const xtd::string &	value,
		type_t &	result,
		xtd::number_styles	styles ) -> bool

inlinestaticnodiscardnoexcept

Converts the string to its type_t equivalent.

Parameters

value A string containing a type_t to convert.

Returns: A type_t equivalent to the number contained in value.

Member Data Documentation

◆ epsilon

template<typename type_t>

type_t xtd::box_floating_point< type_t >::epsilon

staticconstexpr

Represents the smallest positive type_t value greater than zero. This field is constant.

Remarks: The value of this field is std::numeric_limits<type_t>::denorm_min().

◆ max_value

template<typename type_t>

type_t xtd::box_floating_point< type_t >::max_value

staticconstexpr

Represents the largest possible value of type_t. This field is constant.

Remarks: The value of this field is std::numeric_limits<type_t>::max().

◆ min_value

template<typename type_t>

type_t xtd::box_floating_point< type_t >::min_value

staticconstexpr

Represents the smallest possible value of type_t. This field is constant.

Remarks: The value of this field is std::numeric_limits<type_t>::lowest().

◆ NaN

template<typename type_t>

type_t xtd::box_floating_point< type_t >::NaN

staticconstexpr

Represents not a number (NaN). This field is constant.

Remarks: The value of this field is std::numeric_limits<type_t>::quiet_NaN().

◆ negative_infinity

template<typename type_t>

type_t xtd::box_floating_point< type_t >::negative_infinity

staticconstexpr

Represents negative infinity. This field is constant.

Remarks: The value of this field is -std::numeric_limits<type_t>::infinity().

◆ positive_infinity

template<typename type_t>

type_t xtd::box_floating_point< type_t >::positive_infinity

staticconstexpr

Represents positive infinity. This field is constant.

Remarks: The value of this field is std::numeric_limits<type_t>::infinity().

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

xtd.core/include/xtd/box_floating_point.hpp

Definition

Public Fields

Public Static Methods

Additional Inherited Members

Member Function Documentation

◆ is_finite()

◆ is_infinity()

◆ is_NaN()

◆ is_negative_infinity()

◆ is_normal()

◆ is_positive_infinity()

◆ is_subnormal()

◆ is_valid()

◆ is_zero()

◆ parse()

◆ try_parse()

Member Data Documentation

◆ epsilon

◆ max_value

◆ min_value

◆ NaN

◆ negative_infinity

◆ positive_infinity