Namespace breeze

Description

The library's top-level namespace.

Namespaces

	adl_shield	Internal namespace for facilities that must be protected from ADL.
	meta	Namespace for our meta-programming facilities.

Classes

	array_pointer	A smart pointer to an array object.
	big_endian_policy	Big-endian policy for endian_codec.
	boolean_maybe_traits	The default traits class for `maybe`. Logically corresponds to a boolean (valid/invalid).
	c_clock_policy	A policy for our `timer` template using the C function `clock()`.
	counter	A counter providing only operations meaningful for a counter, plus checking of the initial value, of overflow and underflow.
	cpuid_result	The result of the CPUID instruction.
	crc	A generic CRC calculator.
	crc16	Traits for CRC-16 (also known as CRC-16/ARC).
	crc16_ibm3740	Traits for CRC-16/IBM-3740. This CRC is often misidentified as CRC-CCITT and is thus also known as CRC-16/CCITT-FALSE.
	crc32	Traits for CRC-32, as used by Ethernet, Serial ATA, PKZIP, Gzip, Bzip2, PNG.
	crc8_autosar	Traits for the CRC-8 used by AUTOSAR (CRC-8/AUTOSAR).
	crc8_bluetooth	Traits for the CRC-8 used by Bluetooth (CRC-8/BLUETOOTH).
	digest	The result of applying a digest algorithm to a given input sequence.
	endian_codec	Converter from/to byte sequence representations.
	entropy_source	The system entropy source (random numbers).
	exact_width_integer	Provides, if available, an integer type with width `width`.
	exact_width_unsigned_integer	A synonym of `exact_width_integer< width, unsigned >` .
	hashing_count	Count policy for the hashing algorithms.
	inserter	A helper class for writing stream inserters that output directly through the `streambuf`.
	last_api_error	The last error encountered by the calling thread in an OS API call.
	little_endian_policy	Little-endian policy for endian_codec.
	maybe	A template for "maybe" values.
	md5_engine	The MD5 policy class for `merkle_damgard_machine`.
	merkle_damgard_engine	Base class template to ease the definition of policies for the `merkle_damgard_machine` template.
	merkle_damgard_machine	A Merkle-Damgard machine.
	null_stream	A stream that discards any output and provides no input.
	null_stream_buffer	The stream buffer used by `null_stream`.
	operating_system_name	A streamable description of the operating system.
	performance_counter_policy	A timer policy using Windows' `QueryPerformanceCounter()`.
	printable_string	A string with non-printable chars escaped.
	program	A singleton class to manage the overall status of the program and its termination.
	roman	A Roman numeral.
	set_of_chars	A set of chars.
	sha1_engine	SHA-1 policy class for `merkle_damgard_machine`.
	sha224_engine	SHA-224 policy class for `merkle_damgard_machine`.
	sha256_engine	SHA-256 policy class for `merkle_damgard_machine`.
	sha384_engine	SHA-384 policy class for `merkle_damgard_machine`.
	sha512_engine	SHA-512 policy class for `merkle_damgard_machine`.
	steady_clock_policy	A policy for our `timer` template using `std::chrono::steady_clock`.
	stream_buffer_wrapper	Wrapper for a stream buffer.
	stream_equivalent	Wrapper for an "equivalent" of a stream.
	subrange_adaptor	Random or pseudo-random number generator adaptor.
	timer	A policy-based timer class (class template).
	uuid	A universally unique identifier.
	windows_version_info	Microsoft Windows version information.

Functions

	as_non_constant	Makes an expression non-constant.
	base64_to_binary	Decodes a Base64 representation.
	base_file_name	Returns: The file name part of a path
	begin overload	Returns: The same as c.begin(), for any standard container.
	begin overload	Like container::begin(), but for a built-in array.
	begins_with overload	Returns: Whether `s` begins with `with`
	begins_with overload	Returns: `true` if and only if `s` begins with `c`; i.e
	binary_to_base64	Converts a binary sequence to Base64
	bit_cast	Copies the object representation of the object referred to by `from` into an object `t` of type `std::remove_const_t< To >` and returns `t`.
	cbegin overload	Returns: The same as c.begin(), for any standard container.
	cbegin overload	Like container::begin(), but for a built-in array.
	ceiling_of_quotient	Returns the ceiling of the quotient of two integers.
	cend overload	Returns: The same as c.end(), for any standard container.
	cend overload	Like container::end(), but for a built-in array.
	clamp overload	An implementation of the `clamp()` templates introduced in C++17.
	damerau_levenshtein_distance	Returns: The Damerau-Levenshtein distance between `first` and `second`.
	default_assert_handler	The default assert handler for `BREEZE_ASSERT()`.
	digital_root	Returns: The digital root of the number `n` in base `base`.
	end overload	Returns: The same as c.end(), for any standard container.
	end overload	Like container::end(), but for a built-in array.
	endian_load	Convenience wrapper around `endian_codec::decode()`
	endian_store	Convenience wrapper around `endian_codec::encode()`
	ends_with overload	Returns: Whether `s` ends with `with`
	ends_with overload	Returns: `true` if and only if `s` ends with `c`, i.e
	eof_value	Returns: The end-of-file value for the given `Stream`.
	file_name_extension	Returns: The extension of the file name part of `path`, including the period, if any
	format_time	Returns: The time corresponding to `time_stamp`, formatted according to `format`
	from_string	Tries to form an object of type `T` given its textual representation.
	from_string< std::string >	Specialization for `std::string`s.
	gcd	Returns the greatest common divisor of two integers.
	get_all_environment_variables	Returns: A map with all name-value pairs corresponding to the defined environment variables.
	get_amount_of_physical_memory	Returns: The amount of physical memory installed in the system, in KiB.
	get_cpuid_info	Executes the CPUID instruction with the provided values in `EAX` and `ECX`.
	get_current_directory	Gets the current directory of the calling process.
	get_directory_separators	Returns: A pointer to a C string with static storage duration containing the directory separators allowed in the system
	get_environment_variable	Searches an implementation-defined list, as if by calling `std::getenv()`, for a string that matches `name` and returns the associated value, if any.
	get_operating_system_id	Returns the `operating_system_id` of the running operating system (Windows only).
	has_luhn_sum	Returns: Whether the given string has a Luhn sum as its last character.
	integer_log2	Calculates the integer part of the logarithm, to base 2, of its argument.
	is_eof_value	Returns: Whether `x` equals the eof value for the `Stream` given as the second argument.
	is_power_of_2	Returns: `true` if an only if `x` is a power of two.
	lcm	Returns the least common multiple of two integers.
	levenshtein_distance	Returns: The Levenshtein distance between `first` and `second`.
	luhn_check_digit	Returns: The Luhn checksum digit for the given string
	luhn_sum	Returns: The Luhn sum of the given string
	make_digest	Convenience function to create a `digest` from a `Hasher` (can use type deduction).
	max_for_subrange	Returns: The maximum value that can be kept (before taking the remainder of the division by `x + 1`) for getting a random (or pseudo-random) integer in the range `[0, x]` from a source that spans `[0, m]`, `x <= m` .
	operator<	The relational operator functions for operating_system_id are all deleted
	operator<< overload	Stream inserter for crc objects.
	operator<< overload	Outputs a hexadecimal representation of the digest
	operator<< overload	Stream inserter for `operating_system_name`
	operator<< overload	Stream inserter for `operating_system_id`.
	operator<=	The relational operator functions for operating_system_id are all deleted
	operator>	The relational operator functions for operating_system_id are all deleted
	operator>=	The relational operator functions for operating_system_id are all deleted
	population_count	Returns: The number of on bits in the binary representation of the value of `t`
	readable_type_name overload	Returns: A human readable name for the type `T`.
	readable_type_name overload	Returns: A human readable name for the type of the object to which `ref` refers
	remove_from_end overload	Returns: If `s` ends with `to_be_removed`, `s` with the `to_be_removed` part erased from its end; otherwise a copy of `s`.
	remove_from_end overload	Returns: If `s` ends with `c`, `s` with the last character removed; otherwise a copy of `s`.
	replace_all	Replaces all occurrences of `from` in `s` with `to`
	representation_in_base	Returns: The representation, in base `base`, of the integer `n`
	require_type_completeness	To be used to ensure that `T` is a complete type at the point of instantiation
	secure_fill overload	Like `std::fill()`, but guarantees that the range is written to.
	secure_fill overload	Version for built-in arrays.
	set_assert_handler	Sets `*f` as the current "assert handler", i.e
	set_current_directory	Sets the current directory of the calling process to `dir`; `dir` must be a valid directory path.
	signed_count overload	Arrays and containers element counter.
	split	Returns: A vector of strings obtained by splitting `s` at each character present in `separators`, in order.
	split_if	Returns: A vector of strings obtained by splitting `s` at each character which satisfies the predicate `pred`, in order.
	tail	Returns: If `count >= s.length()`, `s`; otherwise the string composed of the last `count` characters of `s` (an empty string if `count == 0`).
	to_lowercase	Converts each character in `source` to lowercase, using the `ctype` facet of the given locale
	to_string overload	Converts an `operating_system_id` to a `std::string`
	to_string overload	Returns: The textual representation of its argument
	to_uppercase	Converts each character in `source` to uppercase, using the `ctype` facet of the given locale
	trim overload	Returns: A string obtained from `s` by removing all the leading and all the trailing characters `c` for which `std::isspace( c, loc )` returns `true`.
	trim overload	Returns: A string obtained from `s` by removing all the leading and all the trailing characters that are also contained in `to_be_removed`.
	trim_head overload	Returns: A string obtained from `s` by removing all the leading characters `c` for which `std::isspace( c, loc )` returns `true`.
	trim_head overload	Returns: A string obtained from `s` by removing all the leading characters that are also contained in `to_be_removed`.
	trim_head_if	Returns: A string obtained from `s` by removing all the leading characters that satisfy the predicate `pred`.
	trim_if	Returns: A string obtained from `s` by removing all the leading and all the trailing characters that satisfy the predicate `pred`.
	trim_tail overload	Returns: A string obtained from `s` by removing all the trailing characters `c` for which `std::isspace( c, loc )` returns `true`.
	trim_tail overload	Returns: A string obtained from `s` by removing all the trailing characters that are also contained in `to_be_removed`.
	trim_tail_if	Returns: A string obtained from `s` by removing all the trailing characters that satisfy the predicate `pred`.
	volatilize	Adds a `volatile` qualification to an lvalue expression, if it doesn't have one.

Enums

	operating_system_id	Operating system identifier for Windows.
	time_kind	The type (UTC/local) of the representation requested to format_time().

Typedefs

Typedefs (md5.hpp)

	typedef merkle_damgard_machine< md5_engine > md5_hasher	A convenience typedef.
	typedef digest< md5_hasher > md5_digest	A convenience typedef.

Typedefs (sha1.hpp)

	typedef merkle_damgard_machine< sha1_engine > sha1_hasher	A convenience typedef.
	typedef digest< sha1_hasher > sha1_digest	A convenience typedef.

Typedefs (sha224.hpp)

	typedef merkle_damgard_machine< sha224_engine > sha224_hasher	A convenience typedef.
	typedef digest< sha224_hasher > sha224_digest	A convenience typedef.

Typedefs (sha256.hpp)

	typedef merkle_damgard_machine< sha256_engine > sha256_hasher	A convenience typedef.
	typedef digest< sha256_hasher > sha256_digest	A convenience typedef.

Typedefs (sha384.hpp)

	typedef merkle_damgard_machine< sha384_engine > sha384_hasher	A convenience typedef.
	typedef digest< sha384_hasher > sha384_digest	A convenience typedef.

Typedefs (sha512.hpp)

	typedef merkle_damgard_machine< sha512_engine > sha512_hasher	A convenience typedef.
	typedef digest< sha512_hasher > sha512_digest	A convenience typedef.

Typedefs (assert.hpp)

typedef void() assert_handler_type(char const *expression_text, char const *file_name, long line_number)

The type of the function called by BREEZE_ASSERT( expression ) if expression evaluates to false.

Parameters

expression_text - A pointer to a C-style string containing the text of expression.

file_name - A pointer to a C-style string containing the name of the source file in which BREEZE_ASSERT() was invoked.

line_number - The line number of the line in which BREEZE_ASSERT() was invoked.

Typedefs (c_clock_timer.hpp)

typedef timer< c_clock_policy > c_clock_timer

Typedefs (steady_clock_timer.hpp)

typedef timer< steady_clock_policy > steady_clock_timer

Variables

Variables (exit_code.hpp)

	int const exit_success
	int const exit_failure
	int const exit_warning
	int const exit_error
	int const exit_fatal
	int const exit_internal

Variables (string_constant.hpp)

	char const latin_small_letters	The string `"abcdefghijklmnopqrstuvwxyz"`. Note This is not a `std::string`, to avoid any initialization order issues.
	char const latin_capital_letters	The string `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"`. Note This is not a `std::string`, to avoid any initialization order issues.
	char const decimal_digits	The string `"0123456789"`. Note This is not a `std::string`, to avoid any initialization order issues.
	char const octal_digits	The string `"01234567"`. Note This is not a `std::string`, to avoid any initialization order issues.
	char const lowercase_hex_digits	The string `"0123456789abcdef"`. Note This is not a `std::string`, to avoid any initialization order issues.
	char const uppercase_hex_digits	The string `"0123456789ABCDEF"`. Note This is not a `std::string`, to avoid any initialization order issues.

Variables (format_time.hpp)

	char const iso8601_basic_date	Gives a calendar date in the format `YYYYMMDD`. These variables allow using meaningful names in combination with `format_time()`; e.g. you can write `format_time( iso8601_extended_date ) ;` Only a small number of format strings are provided. Note These are not `std::string`s, to avoid any order of initialization issues. But this means that e.g. concatening their values may be a bit less straightforward.
	char const iso8601_extended_date	Gives a calendar date in the format `YYYY-MM-DD`.
	char const iso8601_basic_time	Gives a time of the day in the format `hhmmss`.
	char const iso8601_extended_time	Gives a time of the day in the format `hh:mm:ss`.

Source

Line 20 in breeze/algorithm/secure_fill.hpp.