Functions
std::size_t	nonnegative_size (std::ptrdiff_t value, const char *message)
	Converts a signed value to std::size_t after rejecting negatives.
void	require_rank (std::size_t actual, std::size_t expected, const char *message)
	Requires a rank value to match an expected rank.
template<typename Ranked> requires requires(const Ranked& object) { object.rank(); }
const Ranked &	require_rank (const Ranked &object, std::size_t expected, const char *message)
	Requires an object with rank() to match an expected rank.
std::size_t	checked_multiply (std::size_t lhs, std::size_t rhs, const char *message)
	Multiplies two sizes while checking for overflow.
std::size_t	checked_add (std::size_t lhs, std::size_t rhs, const char *message)
	Adds two sizes while checking for overflow.
std::size_t	nonnegative_index (std::ptrdiff_t value, const char *message)
	Converts a signed index to std::size_t after rejecting negatives.
std::size_t	normalize_index (std::ptrdiff_t value, std::size_t size, const char *message)
	Normalizes a potentially negative index against a container size.
void	require_index (std::size_t index, std::size_t size, const char *message)
	Requires an index to be less than a size.
void	require_at_most (std::size_t value, std::size_t upper, const char *message)
	Requires a value to be less than or equal to an upper bound.
std::size_t	nonnegative_shape_dimension (std::ptrdiff_t value, const char *message)
	Converts a signed shape dimension to std::size_t after rejecting negatives.
std::size_t	positive_shape_dimension (std::ptrdiff_t value, const char *message)
	Converts a signed shape dimension to std::size_t after requiring it to be positive.
void	require_positive_shape_dimension (std::size_t value, const char *message)
	Requires an unsigned shape dimension to be positive.
template<typename Lhs, typename Rhs>
bool	same_shape (const Lhs &lhs, const Rhs &rhs)
	Returns whether two array-like objects have identical size and shape.
template<typename Lhs, typename Rhs>
void	require_same_shape (const Lhs &lhs, const Rhs &rhs, const char *message)
	Requires two array-like objects to have identical size and shape.
void	require_equal_size (std::size_t lhs, std::size_t rhs, const char *message)
	Requires two sizes to be equal.
template<typename Actual, typename Expected>
void	require_type (const char *message)
	Requires a type to exactly match an expected type after cv/ref removal.
template<typename T>
void	require_numeric_type (const char *message)
	Requires a type to satisfy Stratax's numeric type rules.
template<typename Lhs, typename Rhs> requires requires { typename Lhs::value_type; typename Rhs::value_type; }
void	require_same_value_type (const Lhs &lhs, const Rhs &rhs, const char *message)
	Requires two array-like objects to have the same value type.

Function Documentation

◆ checked_add()

std::size_t stratax::core::validation::checked_add	(	std::size_t	lhs,
		std::size_t	rhs,
		const char *	message )

inline

Adds two sizes while checking for overflow.

Parameters

lhs	Left operand.
rhs	Right operand.
message	Error message used on overflow.

Returns: Sum of lhs and rhs.

Exceptions

Exceptions::DimensionError If the addition would overflow.

Definition at line 104 of file DimensionValidation.hpp.

◆ checked_multiply()

std::size_t stratax::core::validation::checked_multiply	(	std::size_t	lhs,
		std::size_t	rhs,
		const char *	message )

inline

Multiplies two sizes while checking for overflow.

Parameters

lhs	Left operand.
rhs	Right operand.
message	Error message used on overflow.

Returns: Product of lhs and rhs.

Exceptions

Exceptions::DimensionError If the multiplication would overflow.

Definition at line 80 of file DimensionValidation.hpp.

◆ nonnegative_index()

std::size_t stratax::core::validation::nonnegative_index	(	std::ptrdiff_t	value,
		const char *	message )

inline

Converts a signed index to std::size_t after rejecting negatives.

Parameters

value	Signed index to validate.
message	Error message used when value is negative.

Returns: value converted to std::size_t.

Exceptions

Exceptions::IndexError If value is negative.

Definition at line 20 of file IndexValidation.hpp.

◆ nonnegative_shape_dimension()

std::size_t stratax::core::validation::nonnegative_shape_dimension	(	std::ptrdiff_t	value,
		const char *	message )

inline

Converts a signed shape dimension to std::size_t after rejecting negatives.

Parameters

value	Signed dimension to validate.
message	Error message used when value is negative.

Returns: value converted to std::size_t.

Exceptions

Exceptions::ShapeError If value is negative.

Definition at line 19 of file ShapeValidation.hpp.

◆ nonnegative_size()

std::size_t stratax::core::validation::nonnegative_size	(	std::ptrdiff_t	value,
		const char *	message )

inline

Converts a signed value to std::size_t after rejecting negatives.

Parameters

value	Signed value to validate.
message	Error message used when value is negative.

Returns: value converted to std::size_t.

Exceptions

Exceptions::DimensionError If value is negative.

Definition at line 20 of file DimensionValidation.hpp.

◆ normalize_index()

std::size_t stratax::core::validation::normalize_index	(	std::ptrdiff_t	value,
		std::size_t	size,
		const char *	message )

inline

Normalizes a potentially negative index against a container size.

Negative indices are interpreted from the end of the range, like Python.

Parameters

value	Signed index value.
size	Container size used for normalization.
message	Error message used when the normalized index is out of bounds.

Returns: Normalized non-negative index.

Exceptions

Exceptions::IndexError If the index is out of bounds.

Definition at line 43 of file IndexValidation.hpp.

◆ positive_shape_dimension()

std::size_t stratax::core::validation::positive_shape_dimension	(	std::ptrdiff_t	value,
		const char *	message )

inline

Converts a signed shape dimension to std::size_t after requiring it to be positive.

Parameters

value	Signed dimension to validate.
message	Error message used when value <= 0.

Returns: value converted to std::size_t.

Exceptions

Exceptions::ShapeError If value <= 0.

Definition at line 39 of file ShapeValidation.hpp.

◆ require_at_most()

void stratax::core::validation::require_at_most	(	std::size_t	value,
		std::size_t	upper,
		const char *	message )

inline

Requires a value to be less than or equal to an upper bound.

This is useful for half-open range stops, where stop == size is valid.

Parameters

value	Value to validate.
upper	Inclusive upper bound.
message	Error message used when value > upper.

Exceptions

Exceptions::IndexError If value > upper.

Definition at line 94 of file IndexValidation.hpp.

◆ require_equal_size()

void stratax::core::validation::require_equal_size	(	std::size_t	lhs,
		std::size_t	rhs,
		const char *	message )

inline

Requires two sizes to be equal.

Parameters

lhs	Left size.
rhs	Right size.
message	Error message used on mismatch.

Exceptions

Exceptions::ShapeError If the sizes differ.

Definition at line 106 of file ShapeValidation.hpp.

◆ require_index()

void stratax::core::validation::require_index	(	std::size_t	index,
		std::size_t	size,
		const char *	message )

inline

Requires an index to be less than a size.

Parameters

index	Index to validate.
size	Exclusive upper bound.
message	Error message used when out of bounds.

Exceptions

Exceptions::IndexError If index >= size.

Definition at line 75 of file IndexValidation.hpp.

◆ require_numeric_type()

template<typename T>

void stratax::core::validation::require_numeric_type ( const char * message )

Requires a type to satisfy Stratax's numeric type rules.

Template Parameters

T	Type being validated.

Parameters

message Error message used when the type is unsupported.

Exceptions

Exceptions::TypeError If T is not a supported numeric type.

Definition at line 37 of file TypeValidation.hpp.

◆ require_positive_shape_dimension()

void stratax::core::validation::require_positive_shape_dimension	(	std::size_t	value,
		const char *	message )

inline

Requires an unsigned shape dimension to be positive.

Parameters

value	Dimension to validate.
message	Error message used when value == 0.

Exceptions

Exceptions::ShapeError If value == 0.

Definition at line 57 of file ShapeValidation.hpp.

◆ require_rank() [1/2]

template<typename Ranked>
requires requires(const Ranked& object) { object.rank(); }

const Ranked & stratax::core::validation::require_rank	(	const Ranked &	object,
		std::size_t	expected,
		const char *	message )

Requires an object with rank() to match an expected rank.

Parameters

object	Object to validate.
expected	Required rank.
message	Error message used on mismatch.

Returns: Reference to object.

Exceptions

Exceptions::DimensionError If the object rank differs.

Definition at line 63 of file DimensionValidation.hpp.

◆ require_rank() [2/2]

void stratax::core::validation::require_rank	(	std::size_t	actual,
		std::size_t	expected,
		const char *	message )

inline

Requires a rank value to match an expected rank.

Parameters

actual	Actual rank.
expected	Required rank.
message	Error message used on mismatch.

Exceptions

Exceptions::DimensionError If the ranks differ.

Definition at line 39 of file DimensionValidation.hpp.

◆ require_same_shape()

template<typename Lhs, typename Rhs>

void stratax::core::validation::require_same_shape	(	const Lhs &	lhs,
		const Rhs &	rhs,
		const char *	message )

Requires two array-like objects to have identical size and shape.

Parameters

lhs	Left object.
rhs	Right object.
message	Error message used on mismatch.

Exceptions

Exceptions::ShapeError If size or shape differ.

Definition at line 89 of file ShapeValidation.hpp.

◆ require_same_value_type()

template<typename Lhs, typename Rhs>
requires requires { typename Lhs::value_type; typename Rhs::value_type; }

void stratax::core::validation::require_same_value_type	(	const Lhs &	lhs,
		const Rhs &	rhs,
		const char *	message )

Requires two array-like objects to have the same value type.

Parameters

lhs	Left object.
rhs	Right object.
message	Error message used on mismatch.

Exceptions

Exceptions::TypeError If the objects' normalized value_types differ.

Definition at line 60 of file TypeValidation.hpp.

◆ require_type()

template<typename Actual, typename Expected>

void stratax::core::validation::require_type ( const char * message )

Requires a type to exactly match an expected type after cv/ref removal.

Template Parameters

Actual	Type being validated.
Expected	Required type.

Parameters

message Error message used on mismatch.

Exceptions

Exceptions::TypeError If the normalized types differ.

Definition at line 20 of file TypeValidation.hpp.

◆ same_shape()

template<typename Lhs, typename Rhs>

bool stratax::core::validation::same_shape	(	const Lhs &	lhs,
		const Rhs &	rhs )

nodiscard

Returns whether two array-like objects have identical size and shape.

Parameters

lhs	Left object.
rhs	Right object.

Returns: true if size and shape match.

Definition at line 74 of file ShapeValidation.hpp.

Functions

Function Documentation

◆ checked_add()

◆ checked_multiply()

◆ nonnegative_index()

◆ nonnegative_shape_dimension()

◆ nonnegative_size()

◆ normalize_index()

◆ positive_shape_dimension()

◆ require_at_most()

◆ require_equal_size()

◆ require_index()

◆ require_numeric_type()

◆ require_positive_shape_dimension()

◆ require_rank() [1/2]

◆ require_rank() [2/2]

◆ require_same_shape()

◆ require_same_value_type()

◆ require_type()

◆ same_shape()