xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
xtd::tunit::assume Class Referencefinal

#include <assume.h>

Definition

The assume class contains a collection of static methods that implement the most common assertions used in xtd::tUnit.

Namespace
xtd::tunit
Library
xtd.tunit
Examples
This example show how to used some methods :

Inherits xtd::tunit::base_assert.

Static Public Member Functions

template<typename expected_t , typename actual_t >
static void are_equal (const expected_t &expected, const actual_t &actual)
 Assumes that two type are equal.
 
template<typename expected_t , typename actual_t >
static void are_equal (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
template<typename expected_t , typename actual_t >
static void are_equal (const expected_t &expected, const actual_t &actual, const xtd::ustring &message)
 Assumes that two type are equal.
 
template<typename expected_t , typename actual_t >
static void are_equal (const expected_t &expected, const actual_t &actual, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (double expected, double actual, double tolerance)
 Assumes that two type are equal.
 
static void are_equal (double expected, double actual, double tolerance, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (double expected, double actual, double tolerance, const xtd::ustring &message)
 Assumes that two type are equal.
 
static void are_equal (double expected, double actual, double tolerance, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (float expected, float &actual, float tolerance, const xtd::ustring &message)
 Assumes that two type are equal.
 
static void are_equal (float expected, float actual, float tolerance)
 Assumes that two type are equal.
 
static void are_equal (float expected, float actual, float tolerance, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (float expected, float actual, float tolerance, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (long double expected, long double actual, long double tolerance)
 Assumes that two type are equal.
 
static void are_equal (long double expected, long double actual, long double tolerance, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
static void are_equal (long double expected, long double actual, long double tolerance, const xtd::ustring &message)
 Assumes that two type are equal.
 
static void are_equal (long double expected, long double actual, long double tolerance, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are equal.
 
template<typename expected_t , typename actual_t >
static void are_not_equal (const expected_t &expected, const actual_t &actual)
 Assumes that two type are not equal.
 
template<typename expected_t , typename actual_t >
static void are_not_equal (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are not equal.
 
template<typename expected_t , typename actual_t >
static void are_not_equal (const expected_t &expected, const actual_t &actual, const xtd::ustring &message)
 Assumes that two type are not equal.
 
template<typename expected_t , typename actual_t >
static void are_not_equal (const expected_t &expected, const actual_t &actual, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two type are not equal.
 
template<typename expected_t , typename actual_t >
static void are_not_same (const expected_t &expected, const actual_t &actual)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_not_same (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_not_same (const expected_t &expected, const actual_t &actual, const xtd::ustring &message)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_not_same (const expected_t &expected, const actual_t &actual, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_same (const expected_t &expected, const actual_t &actual)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_same (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_same (const expected_t &expected, const actual_t &actual, const xtd::ustring &message)
 Assumes that two objects do refer to differents objects.
 
template<typename expected_t , typename actual_t >
static void are_same (const expected_t &expected, const actual_t &actual, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that two objects do refer to differents objects.
 
template<typename item_t , typename collection_t >
static void contains (const item_t &item, const collection_t &collection)
 Assumes that collection contains an item.
 
template<typename item_t , typename collection_t >
static void contains (const item_t &item, const collection_t &collection, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection contains an item.
 
template<typename item_t , typename collection_t >
static void contains (const item_t &item, const collection_t &collection, const xtd::ustring &message)
 Assumes that collection contains an item.
 
template<typename item_t , typename collection_t >
static void contains (const item_t &item, const collection_t &collection, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection contains an item.
 
static void does_not_throw (const std::function< void()> &statement)
 Assumes that the staement does not throw an exception.
 
static void does_not_throw (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the staement does not throw an exception.
 
static void does_not_throw (const std::function< void()> &statement, const xtd::ustring &message)
 Assumes that the staement does not throw an exception.
 
static void does_not_throw (const std::function< void()> &statement, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the staement does not throw an exception.
 
template<typename value_t >
static void is_empty (const value_t &value)
 Assumes that collection contains an item.
 
template<typename value_t >
static void is_empty (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection contains an item.
 
template<typename value_t >
static void is_empty (const value_t &value, const xtd::ustring &message)
 Assumes that collection contains an item.
 
template<typename value_t >
static void is_empty (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection contains an item.
 
template<typename value1_t , typename value2_t >
static void is_greater_or_equal (const value1_t &val1, const value2_t &val2)
 Assumes that the first value is greater than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_greater_or_equal (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is greater than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_greater_or_equal (const value1_t &val1, const value2_t &val2, const xtd::ustring &message)
 Assumes that the first value is greater than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_greater_or_equal (const value1_t &val1, const value2_t &val2, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is greater than or equal to the second value.
 
template<typename type_t , typename value_t >
static void is_instance_of (const value_t &value)
 Assumes that an object is of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_instance_of (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that an object is of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_instance_of (const value_t &value, const xtd::ustring &message)
 Assumes that an object is of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_instance_of (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that an object is of the type supplied or a derived type.
 
template<typename value1_t , typename value2_t >
static void is_less (const value1_t &val1, const value2_t &val2)
 Assumes that the first value is is_less than the second value.
 
template<typename value1_t , typename value2_t >
static void is_less (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is is_less than the second value.
 
template<typename value1_t , typename value2_t >
static void is_less (const value1_t &val1, const value2_t &val2, const xtd::ustring &message)
 Assumes that the first value is is_less than the second value.
 
template<typename value1_t , typename value2_t >
static void is_less (const value1_t &val1, const value2_t &val2, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is is_less than the second value.
 
template<typename value1_t , typename value2_t >
static void is_less_or_equal (const value1_t &val1, const value2_t &val2)
 Assumes that the first value is is_less than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_less_or_equal (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is is_less than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_less_or_equal (const value1_t &val1, const value2_t &val2, const xtd::ustring &message)
 Assumes that the first value is is_less than or equal to the second value.
 
template<typename value1_t , typename value2_t >
static void is_less_or_equal (const value1_t &val1, const value2_t &val2, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the first value is is_less than or equal to the second value.
 
static void is_NaN (double value)
 that a value is NaN.
 
static void is_NaN (double value, const xtd::diagnostics::stack_frame &stack_frame)
 that a value is NaN.
 
static void is_NaN (double value, const xtd::ustring &message)
 Assumes that a value is NaN.
 
static void is_NaN (double value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that a value is NaN.
 
static void is_NaN (float value)
 that a value is NaN.
 
static void is_NaN (float value, const xtd::diagnostics::stack_frame &stack_frame)
 that a value is NaN.
 
static void is_NaN (float value, const xtd::ustring &message)
 Assumes that a value is NaN.
 
static void is_NaN (float value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that a value is NaN.
 
static void is_NaN (long double value)
 that a value is NaN.
 
static void is_NaN (long double value, const xtd::diagnostics::stack_frame &stack_frame)
 that a value is NaN.
 
static void is_NaN (long double value, const xtd::ustring &message)
 Assumes that a value is NaN.
 
static void is_NaN (long double value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that a value is NaN.
 
template<typename value_t >
static void is_negative (const value_t &value)
 Assumes that ta condition is negative.
 
template<typename value_t >
static void is_negative (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is negative.
 
template<typename value_t >
static void is_negative (const value_t &value, const xtd::ustring &message)
 Assumes that ta condition is negative.
 
template<typename value_t >
static void is_negative (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is negative.
 
template<typename value_t >
static void is_not_empty (const value_t &value)
 Assumes that collection oes not contain any item.
 
template<typename value_t >
static void is_not_empty (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection does not contain any item.
 
template<typename value_t >
static void is_not_empty (const value_t &value, const xtd::ustring &message)
 Assumes that collection does not contain any item.
 
template<typename value_t >
static void is_not_empty (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that collection does not contain any item.
 
template<typename type_t , typename value_t >
static void is_not_instance_of (const value_t &value)
 Assumes that an object is not of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_not_instance_of (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that an object is not of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_not_instance_of (const value_t &value, const xtd::ustring &message)
 Assumes that an object is not of the type supplied or a derived type.
 
template<typename type_t , typename value_t >
static void is_not_instance_of (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that an object is not of the type supplied or a derived type.
 
template<typename pointer_t >
static void is_not_null (const pointer_t *pointer)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const pointer_t *pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const pointer_t *pointer, const xtd::ustring &message)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const pointer_t *pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::shared_ptr< pointer_t > &pointer)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::shared_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::shared_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::shared_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::unique_ptr< pointer_t > &pointer)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::unique_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::unique_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::unique_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::weak_ptr< pointer_t > &pointer)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::weak_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::weak_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is not null.
 
template<typename pointer_t >
static void is_not_null (const std::weak_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
static void is_not_null (std::nullptr_t pointer)
 Assumes that the pointer is not null.
 
static void is_not_null (std::nullptr_t pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
static void is_not_null (std::nullptr_t pointer, const xtd::ustring &message)
 Assumes that the pointer is not null.
 
static void is_not_null (std::nullptr_t pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is not null.
 
template<typename value_t >
static void is_not_zero (const value_t &value)
 Assumes that ta condition is not zero.
 
template<typename value_t >
static void is_not_zero (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is not zero.
 
template<typename value_t >
static void is_not_zero (const value_t &value, const xtd::ustring &message)
 Assumes that ta condition is not zero.
 
template<typename value_t >
static void is_not_zero (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is not zero.
 
template<typename pointer_t >
static void is_null (const pointer_t *pointer)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const pointer_t *pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const pointer_t *pointer, const xtd::ustring &message)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const pointer_t *pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::shared_ptr< pointer_t > &pointer)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::shared_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::shared_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::shared_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::unique_ptr< pointer_t > &pointer)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::unique_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::unique_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::unique_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::weak_ptr< pointer_t > &pointer)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::weak_ptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::weak_ptr< pointer_t > &pointer, const xtd::ustring &message)
 Assumes that the pointer is null.
 
template<typename pointer_t >
static void is_null (const std::weak_ptr< pointer_t > &pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
static void is_null (std::nullptr_t pointer)
 Assumes that the pointer is null.
 
static void is_null (std::nullptr_t pointer, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
static void is_null (std::nullptr_t pointer, const xtd::ustring &message)
 Assumes that the pointer is null.
 
static void is_null (std::nullptr_t pointer, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the pointer is null.
 
template<typename value_t >
static void is_positive (const value_t &value)
 Assumes that ta condition is positive.
 
template<typename value_t >
static void is_positive (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is positive.
 
template<typename value_t >
static void is_positive (const value_t &value, const xtd::ustring &message)
 Assumes that ta condition is positive.
 
template<typename value_t >
static void is_positive (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is positive.
 
static void is_true (bool condition)
 Assumes that ta condition is true.
 
static void is_true (bool condition, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that a condition is true.
 
static void is_true (bool condition, const xtd::ustring &message)
 Assumes that a condition is true.
 
static void is_true (bool condition, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that a condition is true.
 
template<typename value_t >
static void is_zero (const value_t &value)
 Assumes that ta condition is zero.
 
template<typename value_t >
static void is_zero (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is zero.
 
template<typename value_t >
static void is_zero (const value_t &value, const xtd::ustring &message)
 Assumes that ta condition is zero.
 
template<typename value_t >
static void is_zero (const value_t &value, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that ta condition is zero.
 
template<typename exception_t >
static void throws (const std::function< void()> &statement)
 Assumes that the statement throws a particular exception when called.
 
template<typename exception_t >
static void throws (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the statement throws a particular exception when called.
 
template<typename exception_t >
static void throws (const std::function< void()> &statement, const xtd::ustring &message)
 Assumes that the statement throws a particular exception when called.
 
template<typename exception_t >
static void throws (const std::function< void()> &statement, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the statement throws a particular exception when called.
 
static void throws_any (const std::function< void()> &statement)
 Assumes that the staement does not throw an exception.
 
static void throws_any (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the staement does not throw an exception.
 
static void throws_any (const std::function< void()> &statement, const xtd::ustring &message)
 Assumes that the staement does not throw an exception.
 
static void throws_any (const std::function< void()> &statement, const xtd::ustring &message, const xtd::diagnostics::stack_frame &stack_frame)
 Assumes that the staement does not throw an exception.
 

Member Function Documentation

◆ are_equal() [1/16]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_equal ( const expected_t &  expected,
const actual_t &  actual 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_equal(24, int(24)); // test ok.
xtd::tunit::assume::are_equal(23, int(24)); // test throws an abort_error exception.
static void are_equal(const expected_t &expected, const actual_t &actual)
Assumes that two type are equal.
Definition: assume.h:36

◆ are_equal() [2/16]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_equal(24, int(24), csf_); // test ok.
xtd::tunit::assume::are_equal(23, int(24), csf_); // test throws an abort_error exception.
#define csf_
Provides information about the current stack frame.
Definition: stack_frame.h:213

◆ are_equal() [3/16]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_equal(24, int(24), "User message..."); // test ok.
xtd::tunit::assume::are_equal(23, int(24), "User message..."); // test throws an abort_error exception.

◆ are_equal() [4/16]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_equal(24, int(24), "User message...", csf_); // test ok.
xtd::tunit::assume::are_equal(23, int(24), "User message...", csf_); // test throws an abort_error exception.

◆ are_equal() [5/16]

static void xtd::tunit::assume::are_equal ( double  expected,
double  actual,
double  tolerance 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001); // test throws an abort_error exception.
@ d
The D key.

◆ are_equal() [6/16]

static void xtd::tunit::assume::are_equal ( double  expected,
double  actual,
double  tolerance,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001, csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001, csf_); // test throws an abort_error exception.

◆ are_equal() [7/16]

static void xtd::tunit::assume::are_equal ( double  expected,
double  actual,
double  tolerance,
const xtd::ustring message 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001, "User message..."); // test throws an abort_error exception.

◆ are_equal() [8/16]

static void xtd::tunit::assume::are_equal ( double  expected,
double  actual,
double  tolerance,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001, "User message...", csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001, "User message...", csf_); // test throws an abort_error exception.

◆ are_equal() [9/16]

static void xtd::tunit::assume::are_equal ( float  expected,
float &  actual,
float  tolerance,
const xtd::ustring message 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f, "User message..."); // test throws an abort_error exception.
@ f
The F key.

◆ are_equal() [10/16]

static void xtd::tunit::assume::are_equal ( float  expected,
float  actual,
float  tolerance 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f); // test throws an abort_error exception.

◆ are_equal() [11/16]

static void xtd::tunit::assume::are_equal ( float  expected,
float  actual,
float  tolerance,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f, csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f, csf_); // test throws an abort_error exception.

◆ are_equal() [12/16]

static void xtd::tunit::assume::are_equal ( float  expected,
float  actual,
float  tolerance,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f, "User message...", csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f, "User message...", csf_); // test throws an abort_error exception.

◆ are_equal() [13/16]

static void xtd::tunit::assume::are_equal ( long double  expected,
long double  actual,
long double  tolerance 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l); // test throws an abort_error exception.

◆ are_equal() [14/16]

static void xtd::tunit::assume::are_equal ( long double  expected,
long double  actual,
long double  tolerance,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l, csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l, csf_); // test throws an abort_error exception.

◆ are_equal() [15/16]

static void xtd::tunit::assume::are_equal ( long double  expected,
long double  actual,
long double  tolerance,
const xtd::ustring message 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l, "User message..."); // test throws an abort_error exception.

◆ are_equal() [16/16]

static void xtd::tunit::assume::are_equal ( long double  expected,
long double  actual,
long double  tolerance,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are equal.

Parameters
expectedthe expected value.
actualthe actual value.
toleranceIndicates a tolerance within which they will be considered as equal.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l, "User message...", csf_); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l, "User message...", csf_); // test throws an abort_error exception.

◆ are_not_equal() [1/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected,
const actual_t &  actual 
)
inlinestatic

Assumes that two type are not equal.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_not_equal(23, int(24)); // test ok.
xtd::tunit::assume::are_not_equal(24, int(24)); // test throws an abort_error exception.
static void are_not_equal(const expected_t &expected, const actual_t &actual)
Assumes that two type are not equal.
Definition: assume.h:346

◆ are_not_equal() [2/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are not equal.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_not_equal(23, int(24), csf_); // test ok.
xtd::tunit::assume::are_not_equal(24, int(24), csf_); // test throws an abort_error exception.

◆ are_not_equal() [3/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message 
)
inlinestatic

Assumes that two type are not equal.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_not_equal(23, int(24), "User message..."); // test ok.
xtd::tunit::assume::are_not_equal(24, int(24), "User message..."); // test throws an abort_error exception.

◆ are_not_equal() [4/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two type are not equal.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::are_not_equal(23, int(24), "User message...", csf_); // test ok.
xtd::tunit::assume::are_not_equal(24, int(24), "User message...", csf_); // test throws an abort_error exception.

◆ are_not_same() [1/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_same ( const expected_t &  expected,
const actual_t &  actual 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_not_same(b, a); // test throws an abort_error exception.
static void are_not_same(const expected_t &expected, const actual_t &actual)
Assumes that two objects do refer to differents objects.
Definition: assume.h:449
@ a
The A key.
@ c
The C key.
@ b
The B key.

◆ are_not_same() [2/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_not_same(b, a, stack_frame); // test throws an abort_error exception.

◆ are_not_same() [3/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_not_same(c, a, "User message..."); // test ok.
xtd::tunit::assume::are_not_same(b, a, "User message..."); // test throws an abort_error exception.

◆ are_not_same() [4/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_not_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_not_same(c, a, "User message...", csf_); // test ok.
xtd::tunit::assume::are_not_same(b, a, "User message...", stack_frame); // test throws an abort_error exception.

◆ are_same() [1/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_same ( const expected_t &  expected,
const actual_t &  actual 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_same(c, a); // test throws an abort_error exception.
static void are_same(const expected_t &expected, const actual_t &actual)
Assumes that two objects do refer to differents objects.
Definition: assume.h:519

◆ are_same() [2/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_same(c, a, csf_); // test throws an abort_error exception.

◆ are_same() [3/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_same(b, a, "User message..."); // test ok.
xtd::tunit::assume::are_same(c, a, "User message..."); // test throws an abort_error exception.

◆ are_same() [4/4]

template<typename expected_t , typename actual_t >
static void xtd::tunit::assume::are_same ( const expected_t &  expected,
const actual_t &  actual,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that two objects do refer to differents objects.

Parameters
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int a = 24;
int& b = a;
int c= 24;
xtd::tunit::assume::are_same(b, a, "User message...", csf_); // test ok.
xtd::tunit::assume::are_same(c, a, "User message...", csf_); // test throws an abort_error exception.

◆ contains() [1/4]

template<typename item_t , typename collection_t >
static void xtd::tunit::assume::contains ( const item_t &  item,
const collection_t &  collection 
)
inlinestatic

Assumes that collection contains an item.

Parameters
itemobject to verify.
collectionthat contains object.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1); // test ok.
xtd::tunit::assume::contains(4, v1); // test throws an abort_error exception.
static void contains(const item_t &item, const collection_t &collection)
Assumes that collection contains an item.
Definition: assume.h:587

◆ contains() [2/4]

template<typename item_t , typename collection_t >
static void xtd::tunit::assume::contains ( const item_t &  item,
const collection_t &  collection,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection contains an item.

Parameters
itemobject to verify.
collectionthat contains object.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1, csf_); // test ok.
xtd::tunit::assume::contains(4, v1, csf_); // test throws an abort_error exception.

◆ contains() [3/4]

template<typename item_t , typename collection_t >
static void xtd::tunit::assume::contains ( const item_t &  item,
const collection_t &  collection,
const xtd::ustring message 
)
inlinestatic

Assumes that collection contains an item.

Parameters
itemobject to verify.
collectionthat contains object.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1, "User message..."); // test ok.
xtd::tunit::assume::contains(4, v1, "User message..."); // test throws an abort_error exception.

◆ contains() [4/4]

template<typename item_t , typename collection_t >
static void xtd::tunit::assume::contains ( const item_t &  item,
const collection_t &  collection,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection contains an item.

Parameters
itemobject to verify.
collectionthat contains object.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1, "User message...", csf_); // test ok.
xtd::tunit::assume::contains(4, v1, "User message...", csf_); // test throws an abort_error exception.

◆ does_not_throw() [1/4]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}); // test throws an abort_error exception.
static void does_not_throw(const std::function< void()> &statement)
Assumes that the staement does not throw an exception.
Definition: assume.h:704

◆ does_not_throw() [2/4]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}, csf_); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}, csf_); // test throws an abort_error exception.

◆ does_not_throw() [3/4]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement,
const xtd::ustring message 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}, "User message..."); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}, "User message..."); // test throws an abort_error exception.

◆ does_not_throw() [4/4]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}, "User message...", csf_); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}, "User message...", csf_); // test throws an abort_error exception.

◆ is_empty() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_empty ( const value_t &  value)
inlinestatic

Assumes that collection contains an item.

Parameters
valueThe value to check is empty.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v2); // test throws an abort_error exception.
static void is_empty(const value_t &value)
Assumes that collection contains an item.
Definition: assume.h:760

◆ is_empty() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_empty ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection contains an item.

Parameters
valueThe value to check is empty.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v2, csf_); // test throws an abort_error exception.

◆ is_empty() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_empty ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that collection contains an item.

Parameters
valueThe value to check is empty.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v1, "User message..."); // test ok.
xtd::tunit::assume::is_empty(v2, "User message..."); // test throws an abort_error exception.

◆ is_empty() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_empty ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection contains an item.

Parameters
valueThe value to check is empty.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_empty(v2, "User message...", csf_); // test throws an abort_error exception.

◆ is_greater_or_equal() [1/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1,
const value2_t &  val2 
)
inlinestatic

Assumes that the first value is greater than or equal to the second value.

Parameters
val1the first value.
val2the second value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_greater_or_equal(24, 48); // test throws an abort_error exception.
static void is_greater_or_equal(const value1_t &val1, const value2_t &val2)
Assumes that the first value is greater than or equal to the second value.
Definition: assume.h:1037

◆ is_greater_or_equal() [2/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is greater than or equal to the second value.

Parameters
val1the first value.
val2the second value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_greater_or_equal(24, 48, csf_); // test throws an abort_error exception.

◆ is_greater_or_equal() [3/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message 
)
inlinestatic

Assumes that the first value is greater than or equal to the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_greater_or_equal(24, 12, "User message..."); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 24, "User message..."); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 48, "User message..."); // test throws an abort_error exception.

◆ is_greater_or_equal() [4/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is greater than or equal to the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_greater_or_equal(24, 12, "User message...", csf_); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 24, "User message...", csf_); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 48, "User message...", csf_); // test throws an abort_error exception.

◆ is_instance_of() [1/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_instance_of ( const value_t &  value)
inlinestatic

Assumes that an object is of the type supplied or a derived type.

Parameters
valueThe object to verify
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except); test fails
Definition: test.h:24

◆ is_instance_of() [2/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_instance_of ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that an object is of the type supplied or a derived type.

Parameters
valueThe object to verify
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except, csf_); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except, csf_); test fails

◆ is_instance_of() [3/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_instance_of ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that an object is of the type supplied or a derived type.

Parameters
valueThe object to verify
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except, "User message..."); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except, "User message..."); test fails

◆ is_instance_of() [4/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_instance_of ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that an object is of the type supplied or a derived type.

Parameters
valueThe object to verify
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except, "User message...", csf_); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except, "User message...", csf_); test fails

◆ is_less() [1/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less ( const value1_t &  val1,
const value2_t &  val2 
)
inlinestatic

Assumes that the first value is is_less than the second value.

Parameters
val1the first value.
val2the second value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less(24, 48); // test ok.
xtd::tunit::assume::is_less(24, 12); // test throws an abort_error exception.
static void is_less(const value1_t &val1, const value2_t &val2)
Assumes that the first value is is_less than the second value.
Definition: assume.h:1198

◆ is_less() [2/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less ( const value1_t &  val1,
const value2_t &  val2,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is is_less than the second value.

Parameters
val1the first value.
val2the second value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less(24, 48, csf_); // test ok.
xtd::tunit::assume::is_less(24, 12, csf_); // test throws an abort_error exception.

◆ is_less() [3/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message 
)
inlinestatic

Assumes that the first value is is_less than the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less(24, 48, "User message..."); // test ok.
xtd::tunit::assume::is_less(24, 12, "User message..."); // test throws an abort_error exception.

◆ is_less() [4/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is is_less than the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less(24, 48, "User message...", csf_); // test ok.
xtd::tunit::assume::is_less(24, 12, "User message...", csf_); // test throws an abort_error exception.

◆ is_less_or_equal() [1/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1,
const value2_t &  val2 
)
inlinestatic

Assumes that the first value is is_less than or equal to the second value.

Parameters
val1the first value.
val2the second value.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less_or_equal(24, 12); // test throws an abort_error exception.
static void is_less_or_equal(const value1_t &val1, const value2_t &val2)
Assumes that the first value is is_less than or equal to the second value.
Definition: assume.h:1299

◆ is_less_or_equal() [2/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is is_less than or equal to the second value.

Parameters
val1the first value.
val2the second value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less_or_equal(24, 12, csf_); // test throws an abort_error exception.

◆ is_less_or_equal() [3/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message 
)
inlinestatic

Assumes that the first value is is_less than or equal to the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less_or_equal(24, 48, "User message..."); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 24, "User message..."); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 12, "User message..."); // test throws an abort_error exception.

◆ is_less_or_equal() [4/4]

template<typename value1_t , typename value2_t >
static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1,
const value2_t &  val2,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the first value is is_less than or equal to the second value.

Parameters
val1the first value.
val2the second value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_less_or_equal(24, 48, "User message...", csf_); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 24, "User message...", csf_); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 12, "User message...", csf_); // test throws an abort_error exception.

◆ is_NaN() [1/12]

static void xtd::tunit::assume::is_NaN ( double  value)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.
static void is_NaN(double value)
that a value is NaN.
Definition: assume.h:1402

◆ is_NaN() [2/12]

static void xtd::tunit::assume::is_NaN ( double  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v2, csf_); // test throws an abort_error exception.

◆ is_NaN() [3/12]

static void xtd::tunit::assume::is_NaN ( double  value,
const xtd::ustring message 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

◆ is_NaN() [4/12]

static void xtd::tunit::assume::is_NaN ( double  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message...", csf_); // test throws an abort_error exception.

◆ is_NaN() [5/12]

static void xtd::tunit::assume::is_NaN ( float  value)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.

◆ is_NaN() [6/12]

static void xtd::tunit::assume::is_NaN ( float  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v2, csf_); // test throws an abort_error exception.

◆ is_NaN() [7/12]

static void xtd::tunit::assume::is_NaN ( float  value,
const xtd::ustring message 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

◆ is_NaN() [8/12]

static void xtd::tunit::assume::is_NaN ( float  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message...", csf_); // test throws an abort_error exception.

◆ is_NaN() [9/12]

static void xtd::tunit::assume::is_NaN ( long double  value)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double v1 = std::numeric_limits<double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.

◆ is_NaN() [10/12]

static void xtd::tunit::assume::is_NaN ( long double  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

that a value is NaN.

Parameters
valueThe value to check is NaN.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v2, csf_); // test throws an abort_error exception.

◆ is_NaN() [11/12]

static void xtd::tunit::assume::is_NaN ( long double  value,
const xtd::ustring message 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

◆ is_NaN() [12/12]

static void xtd::tunit::assume::is_NaN ( long double  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that a value is NaN.

Parameters
valueThe value to check is NaN.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message...", csf_); // test throws an abort_error exception.

◆ is_negative() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_negative ( const value_t &  value)
inlinestatic

Assumes that ta condition is negative.

Parameters
valueThe value to check is negative.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i2); // test throws an abort_error exception.
static void is_negative(const value_t &value)
Assumes that ta condition is negative.
Definition: assume.h:1577

◆ is_negative() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_negative ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is negative.

Parameters
valueThe value to check is negative.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i2, csf_); // test throws an abort_error exception.

◆ is_negative() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_negative ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that ta condition is negative.

Parameters
valueThe value to check is negative.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i1, "User message..."); // test ok.
xtd::tunit::assume::is_negative(i2, "User message..."); // test throws an abort_error exception.

◆ is_negative() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_negative ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is negative.

Parameters
valueThe value to check is negative.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_negative(i2, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_empty() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_empty ( const value_t &  value)
inlinestatic

Assumes that collection oes not contain any item.

Parameters
valueThe value to check is empty.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v2); // test throws an abort_error exception.
static void is_not_empty(const value_t &value)
Assumes that collection oes not contain any item.
Definition: assume.h:1639

◆ is_not_empty() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_empty ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection does not contain any item.

Parameters
valueThe value to check is empty.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v2, csf_); // test throws an abort_error exception.

◆ is_not_empty() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_empty ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that collection does not contain any item.

Parameters
valueThe value to check is empty.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v1, "User message..."); // test ok.
xtd::tunit::assume::is_not_empty(v2, "User message..."); // test throws an abort_error exception.

◆ is_not_empty() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_empty ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that collection does not contain any item.

Parameters
valueThe value to check is empty.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_empty(v2, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_instance_of() [1/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value)
inlinestatic

Assumes that an object is not of the type supplied or a derived type.

Parameters
valueThe object to verify
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except); test fails

◆ is_not_instance_of() [2/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that an object is not of the type supplied or a derived type.

Parameters
valueThe object to verify
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except, csf_); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except, csf_); test fails

◆ is_not_instance_of() [3/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that an object is not of the type supplied or a derived type.

Parameters
valueThe object to verify
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except, "User message..."); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except, "User message..."); test fails

◆ is_not_instance_of() [4/4]

template<typename type_t , typename value_t >
static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that an object is not of the type supplied or a derived type.

Parameters
valueThe object to verify
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except, "User message...", csf_); test fails

◆ is_not_null() [1/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.
static void is_not_null(const pointer_t *pointer)
Assumes that the pointer is not null.
Definition: assume.h:1817

◆ is_not_null() [2/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s2, csf_); // test throws an abort_error exception.

◆ is_not_null() [3/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_not_null() [4/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_null() [5/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::shared_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

◆ is_not_null() [6/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s2, csf_); // test throws an abort_error exception.

◆ is_not_null() [7/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_not_null() [8/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1 = std::make_shared<std::string>("Anything");
std::shared_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_null() [9/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::unique_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

◆ is_not_null() [10/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s2, csf_); // test throws an abort_error exception.

◆ is_not_null() [11/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_not_null() [12/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1 = std::make_unique<std::string>("Anything");
std::unique_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_null() [13/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::weak_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
Remarks
Always true, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
@ s
The S key.

◆ is_not_null() [14/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Remarks
Always true, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;

◆ is_not_null() [15/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Remarks
Always true, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test ok.

◆ is_not_null() [16/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_not_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Remarks
Always true, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1 = s;
std::weak_ptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message...", csf_); // test ok.

◆ is_not_null() [17/20]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_not_null(nullptr); // test throws an abort_error exception.

◆ is_not_null() [18/20]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_not_null(nullptr, csf_); // test throws an abort_error exception.

◆ is_not_null() [19/20]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_not_null(nullptr, "User message..."); // test throws an abort_error exception.

◆ is_not_null() [20/20]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is not null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_not_null(nullptr, "User message...", csf_); // test throws an abort_error exception.

◆ is_not_zero() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_zero ( const value_t &  value)
inlinestatic

Assumes that ta condition is not zero.

Parameters
valueThe value to check is not zero.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i2); // test throws an abort_error exception.
static void is_not_zero(const value_t &value)
Assumes that ta condition is not zero.
Definition: assume.h:2120

◆ is_not_zero() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_zero ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is not zero.

Parameters
valueThe value to check is not zero.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i2, csf_); // test throws an abort_error exception.

◆ is_not_zero() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_zero ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that ta condition is not zero.

Parameters
valueThe value to check is not zero.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i1, "User message..."); // test ok.
xtd::tunit::assume::is_not_zero(i2, "User message..."); // test throws an abort_error exception.

◆ is_not_zero() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_not_zero ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is not zero.

Parameters
valueThe value to check is not zero.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_not_zero(i2, "User message...", csf_); // test throws an abort_error exception.

◆ is_null() [1/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const pointer_t *  pointer)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.
static void is_null(const pointer_t *pointer)
Assumes that the pointer is null.
Definition: assume.h:2183

◆ is_null() [2/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const pointer_t *  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s2, csf_); // test throws an abort_error exception.

◆ is_null() [3/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const pointer_t *  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_null() [4/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const pointer_t *  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_null() [5/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::shared_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

◆ is_null() [6/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
xtd::tunit::assume::is_null(s2, csf_); // test throws an abort_error exception.

◆ is_null() [7/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_null() [8/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::shared_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s1;
std::shared_ptr<std::string> s2 = std::make_shared<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_null() [9/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::unique_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

◆ is_null() [10/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
xtd::tunit::assume::is_null(s2, csf_); // test throws an abort_error exception.

◆ is_null() [11/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_null() [12/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::unique_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::unique_ptr<std::string> s1;
std::unique_ptr<std::string> s2 = std::make_unique<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_null() [13/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::weak_ptr< pointer_t > &  pointer)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
Remarks
Always false, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

◆ is_null() [14/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Remarks
Always false, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1, csf_); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2, csf_); // test throws an abort_error exception.

◆ is_null() [15/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Remarks
Always false, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1, "User message..."); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

◆ is_null() [16/20]

template<typename pointer_t >
static void xtd::tunit::assume::is_null ( const std::weak_ptr< pointer_t > &  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Remarks
Always false, a weaptr can't be equal to nullptr by contruction or assignation.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::shared_ptr<std::string> s = std::make_shared<std::string>("Anything");
std::weak_ptr<std::string> s1;
std::weak_ptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1, "User message...", csf_); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2, "User message...", csf_); // test throws an abort_error exception.

◆ is_null() [17/20]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_null(nullptr); // test ok.

◆ is_null() [18/20]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
stack_frameContains information about current file and current line.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_null(nullptr, csf_); // test ok.

◆ is_null() [19/20]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer,
const xtd::ustring message 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_null(nullptr, "User message..."); // test ok.

◆ is_null() [20/20]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the pointer is null.

Parameters
pointerThe pointer to check is null.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Remarks
Always false, a nullptr_t is always equal to nullptr.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
xtd::tunit::assume::is_null(nullptr, "User message...", csf_); // test ok.

◆ is_positive() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_positive ( const value_t &  value)
inlinestatic

Assumes that ta condition is positive.

Parameters
valueThe value to check is positive.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i2); // test throws an abort_error exception.
static void is_positive(const value_t &value)
Assumes that ta condition is positive.
Definition: assume.h:2486

◆ is_positive() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_positive ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is positive.

Parameters
valueThe value to check is positive.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i2, csf_); // test throws an abort_error exception.

◆ is_positive() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_positive ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that ta condition is positive.

Parameters
valueThe value to check is positive.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i1, "User message..."); // test ok.
xtd::tunit::assume::is_positive(i2, "User message..."); // test throws an abort_error exception.

◆ is_positive() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_positive ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is positive.

Parameters
valueThe value to check is positive.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_positive(i2, "User message...", csf_); // test throws an abort_error exception.

◆ is_true() [1/4]

static void xtd::tunit::assume::is_true ( bool  condition)
inlinestatic

Assumes that ta condition is true.

Parameters
conditionThe condition to check is true.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1)); // test ok.
xtd::tunit::assume::is_false(std::empty(s2)); // test throws an abort_error exception.

◆ is_true() [2/4]

static void xtd::tunit::assume::is_true ( bool  condition,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that a condition is true.

Parameters
conditionThe condition to check is true.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1), csf_); // test ok.
xtd::tunit::assume::is_false(std::empty(s2), csf_); // test throws an abort_error exception.

◆ is_true() [3/4]

static void xtd::tunit::assume::is_true ( bool  condition,
const xtd::ustring message 
)
inlinestatic

Assumes that a condition is true.

Parameters
conditionThe condition to check is true.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1), "User message..."); // test ok.
xtd::tunit::assume::is_false(std::empty(s2), "User message..."); // test throws an abort_error exception.

◆ is_true() [4/4]

static void xtd::tunit::assume::is_true ( bool  condition,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that a condition is true.

Parameters
conditionThe condition to check is true.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1), "User message...", csf_); // test ok.
xtd::tunit::assume::is_false(std::empty(s2), "User message...", csf_); // test throws an abort_error exception.

◆ is_zero() [1/4]

template<typename value_t >
static void xtd::tunit::assume::is_zero ( const value_t &  value)
inlinestatic

Assumes that ta condition is zero.

Parameters
valueThe value to check is zero.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i2); // test throws an abort_error exception.
static void is_zero(const value_t &value)
Assumes that ta condition is zero.
Definition: assume.h:2606

◆ is_zero() [2/4]

template<typename value_t >
static void xtd::tunit::assume::is_zero ( const value_t &  value,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is zero.

Parameters
valueThe value to check is zero.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i2, csf_); // test throws an abort_error exception.

◆ is_zero() [3/4]

template<typename value_t >
static void xtd::tunit::assume::is_zero ( const value_t &  value,
const xtd::ustring message 
)
inlinestatic

Assumes that ta condition is zero.

Parameters
valueThe value to check is zero.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i1, "User message..."); // test ok.
xtd::tunit::assume::is_zero(i2, "User message..."); // test throws an abort_error exception.

◆ is_zero() [4/4]

template<typename value_t >
static void xtd::tunit::assume::is_zero ( const value_t &  value,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that ta condition is zero.

Parameters
valueThe value to check is zero.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i1, "User message...", csf_); // test ok.
xtd::tunit::assume::is_zero(i2, "User message...", csf_); // test throws an abort_error exception.

◆ throws() [1/4]

template<typename exception_t >
static void xtd::tunit::assume::throws ( const std::function< void()> &  statement)
inlinestatic

Assumes that the statement throws a particular exception when called.

Template Parameters
exception_tThe exception type that must be throw.
Parameters
statementThe statement that verify.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}); // test throws an abort_error exception.

◆ throws() [2/4]

template<typename exception_t >
static void xtd::tunit::assume::throws ( const std::function< void()> &  statement,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the statement throws a particular exception when called.

Template Parameters
exception_tThe exception type that must be throw.
Parameters
statementThe statement that verify.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}, csf_); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}, csf_); // test throws an abort_error exception.

◆ throws() [3/4]

template<typename exception_t >
static void xtd::tunit::assume::throws ( const std::function< void()> &  statement,
const xtd::ustring message 
)
inlinestatic

Assumes that the statement throws a particular exception when called.

Template Parameters
exception_tThe exception type that must be throw.
Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}, "User message..."); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}, "User message..."); // test throws an abort_error exception.

◆ throws() [4/4]

template<typename exception_t >
static void xtd::tunit::assume::throws ( const std::function< void()> &  statement,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the statement throws a particular exception when called.

Template Parameters
exception_tThe exception type that must be throw.
Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}, "User message...", csf_); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}, "User message...", csf_); // test throws an abort_error exception.

◆ throws_any() [1/4]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}); // test throws an abort_error exception.
static void throws_any(const std::function< void()> &statement)
Assumes that the staement does not throw an exception.
Definition: assume.h:2728

◆ throws_any() [2/4]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}, csf_); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}, csf_); // test throws an abort_error exception.

◆ throws_any() [3/4]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement,
const xtd::ustring message 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}, "User message..."); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}, "User message..."); // test throws an abort_error exception.

◆ throws_any() [4/4]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement,
const xtd::ustring message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Assumes that the staement does not throw an exception.

Parameters
statementThe statement that verify.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf bad assertion.
Examples
std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}, "User message...", csf_); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}, "User message...", csf_); // test throws an abort_error exception.

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