Namespace breeze

Description

The library's top-level namespace.

Namespaces

adl_shieldInternal namespace for facilities that must be protected from ADL.

Classes

array_pointerA smart pointer to an array object.
bench_harnessA harness for running benchmarks.
big_endian_policyBig-endian policy for endian_codec.
boolean_maybe_traitsThe default traits class for maybe. Logically corresponds to a boolean (valid/invalid).
c_clock_clockA clock for our stopwatch template using the C function clock().
counterA counter providing only operations meaningful for a counter, plus checking of the initial value, of overflow and underflow.
cpuid_resultThe result of the CPUID instruction.
crcA generic CRC calculator.
crc16Traits for CRC-16 (also known as CRC-16/ARC).
crc16_ibm3740Traits for CRC-16/IBM-3740. This CRC is often misidentified as CRC-CCITT and is thus also known as CRC-16/CCITT-FALSE.
crc32Traits for CRC-32/ISO-HDLC. This is the CRC used by PKZIP.
crc8_autosarTraits for the CRC-8 used by AUTOSAR (CRC-8/AUTOSAR).
crc8_bluetoothTraits for the CRC-8 used by Bluetooth (CRC-8/BLUETOOTH).
digestThe result of applying a digest algorithm to a given input sequence.
endian_codecConverter from/to "byte" sequence representations.
entropy_sourceThe system entropy source (random numbers).
hashing_countCount policy for the hashing algorithms.
inserterA helper class for writing stream inserters that output directly through the streambuf.
integer_by_widthProvides, if possible, a typedef to a built-in integer type with width width.
last_api_errorThe last error encountered by the calling thread in an OS API call.
little_endian_policyLittle-endian policy for endian_codec.
maybeA template for "maybe" values.
md5_engineThe MD5 policy class for merkle_damgard_machine.
merkle_damgard_engineBase class template to ease the definition of policies for the merkle_damgard_machine template.
merkle_damgard_machineA Merkle-Damgard machine.
null_streamA stream that discards any output and provides no input.
null_stream_bufferThe stream buffer used by null_stream.
operating_system_nameA streamable description of the operating system.
performance_counter_clockA clock for our stopwatch template using Windows' QueryPerformanceCounter().
printable_stringA string with non-printable chars escaped.
process_durationAn aggregate holding the amounts of user and system time, and of wall-clock time, measured by process_stopwatch.
process_stopwatchA process stopwatch.
programA singleton class to manage the overall status of the program and its termination.
romanA Roman numeral.
selectCompile-time selection between types.
set_of_charsA set of chars.
sha1_engineSHA-1 policy class for merkle_damgard_machine.
sha224_engineSHA-224 policy class for merkle_damgard_machine.
sha256_engineSHA-256 policy class for merkle_damgard_machine.
sha384_engineSHA-384 policy class for merkle_damgard_machine.
sha512_224_engineSHA-512/224 policy class for merkle_damgard_machine.
sha512_256_engineSHA-512/256 policy class for merkle_damgard_machine.
sha512_engineSHA-512 policy class for merkle_damgard_machine.
signed_integer_by_widthEquivalent to integer_by_width< width, signed >.
stopwatchA policy-based stopwatch class (class template).
stream_buffer_wrapperWrapper for a stream buffer.
stream_equivalentWrapper for an "equivalent" of a stream.
string_builderA minimalistic string builder for building error messages.
subrange_adaptorRandom or pseudo-random number generator adaptor.
unqualifyMetafunction to get the corresponding unqualified type of its argument.
unsigned_integer_by_widthEquivalent to integer_by_width< width, unsigned >.
uuidA universally unique identifier.
windows_version_infoMicrosoft Windows version information.

Functions

base64_to_binaryDecodes a Base64 representation.
begin overloadReturns the same as c.begin(), for any standard container.
begin overloadLike container::begin(), but for a built-in array.
begins_with overloadChecks whether s begins with with.
begins_with overloadChecks whether s begins with c.
binary_to_base64Encodes a binary sequence to Base64.
bit_castCopies an object representation.
cbegin overloadReturns the same as c.begin(), for any standard container.
cbegin overloadLike container::begin(), but for a built-in array.
ceiling_of_quotientReturns the ceiling of the quotient of two integers.
cend overloadReturns the same as c.end(), for any standard container.
cend overloadLike container::end(), but for a built-in array.
checked_castConverts between integral types, with range checking.
damerau_levenshtein_distanceReturns the Damerau-Levenshtein distance between first and second.
default_assert_handlerThe default assert handler for BREEZE_ASSERT().
digital_rootReturns the digital root of the number n in base base.
end overloadReturns the same as c.end(), for any standard container.
end overloadLike container::end(), but for a built-in array.
endian_loadConvenience wrapper around endian_codec::decode() which derives Byte from the iterator type.
endian_storeConvenience wrapper around endian_codec::encode() which derives Byte from the iterator type.
ends_with overloadChecks whether s ends with with.
ends_with overloadChecks whether s ends with c.
eof_valueA replacement for EOF and char_traits::eof().
format_timeProduces a textual representation of a std::chrono::system_clock::time_point.
from_stringTries to form an object of type T given its textual representation.
from_string< std::string >Specialization for std::strings.
gcdReturns the greatest common divisor of two integers.
get_all_environment_variablesGets a map with the names and values of all the defined environment variables.
get_amount_of_physical_memoryGets the amount of physical memory installed in the system, in KiB.
get_cpuid_infoExecutes the CPUID instruction with the provided values in EAX and ECX.
get_directory_separatorsReturns the allowed directory separators in the running system.
get_environment_variableRetrieves the value of an environment variable.
get_operating_system_idReturns the operating_system_id of the running operating system (Windows only).
has_luhn_sumChecks if a string ends with a Luhn sum.
has_signA constexpr function template telling whether a type allows negative values.
integer_log2Returns the integer part of the logarithm, to base 2, of its argument.
is_2s_complementTells whether a type uses a two's complement representation.
is_power_of_2Returns true if an only if x is a power of two.
iso8601_basic_date_formatReturns: A format string that can be passed to format_time() to get a calendar date in the format YYYYMMDD.
iso8601_basic_time_formatReturns: A format string that can be passed to format_time() to get a time of the day in the format hhmmss.
iso8601_extended_date_formatReturns: A format string that can be passed to format_time() to get a a calendar date in the format YYYY-MM-DD.
iso8601_extended_time_formatReturns: A format string that can be passed to format_time() to get a time of the day in the format hh:mm:ss.
lcmReturns the least common multiple of two integers.
levenshtein_distanceReturns the Levenshtein distance between first and second.
luhn_check_digitCalculates a Luhn checksum digit, as a char.
luhn_sumCalculates the Luhn sum of a string.
make_digestConvenience function to create a digest from a Hasher (can use type deduction).
max_for_subrangeMax for subrange adaptation.
operator<Deleted operator function for operating_system_id.
operator<< overloadStream inserter for crc objects.
operator<< overloadOutputs a Roman numeral to a stream.
operator<< overloadOutputs a hexadecimal representation of the digest.
operator<< overloadOutputs a textual representation of a last_api_error.
operator<< overloadOutputs a description of the operating system.
operator<< overloadStream inserter for operating_system_id.
operator<< overloadOutputs a printable_string.
operator<< overloadOutputs a process_duration.
operator<=Deleted operator function for operating_system_id.
operator>Deleted operator function for operating_system_id.
operator>=Deleted operator function for operating_system_id.
pad_both_endsPads a std::string at both ends.
pad_headPads the head of a std::string.
pad_tailPads the tail of a std::string.
paddingA constexpr function yielding the number of padding bits of a type.
population_countReturns the number of on bits in the binary representation of the value of t.
precisionReturns the precision of a type.
readable_type_name overloadReturns a human readable name for a type.
readable_type_name overloadReturns a human readable name for the type of an object.
remove_from_end overloadRemoves a given string from the end of another one.
remove_from_end overloadRemoves a given character from the end of a string.
replace_allReplaces all occurrences of a given substring.
representation_in_baseReturns the representation, in base base, of the integer n.
require_type_completenessRequires that T is a complete type at the point of instantiation.
set_assert_handlerSets *f as the current "assert handler".
signed_count overloadArrays and containers element counter.
signed_count overloadA shortcut to signed_count< long long >( t )
splitSplits a std::string into a std::vector of std::strings.
split_ifSplits a std::string into a std::vector of std::strings.
tailReturns the tail of a string.
to_lowercaseConverts a string to lowercase (with 1:1 mapping).
to_string overloadConverts an operating_system_id to a std::string
to_string overloadReturns a textual representation of an object.
to_string overloadReturns a textual representation of a std::chrono::duration.
to_uppercaseConverts a string to uppercase (with 1:1 mapping).
trim overloadTrims a std::string.
trim_head overloadTrims the head of a std::string.
trim_head_ifTrims the head of a std::string.
trim_ifTrims a std::string.
trim_tail overloadTrims the tail of a std::string.
trim_tail_ifReturns: A string obtained from s by removing all the trailing characters that satisfy the predicate pred.
widthReturns the width of a type.

Enums

operating_system_idOperating system identifier for Windows.
time_kindThe type (UTC/local) of the representation requested to format_time().
exit_codeConstants for program exit codes.

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.

typedef merkle_damgard_machine< sha512_224_engine > sha512_224_hasher

A convenience typedef.

typedef digest< sha512_224_hasher > sha512_224_digest

A convenience typedef.

typedef merkle_damgard_machine< sha512_256_engine > sha512_256_hasher

A convenience typedef.

typedef digest< sha512_256_hasher > sha512_256_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_stopwatch.hpp)

typedef stopwatch< c_clock_clock > c_clock_stopwatch

Typedefs (performance_counter_stopwatch.hpp)

typedef stopwatch< performance_counter_clock > performance_counter_stopwatch

Variables

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.

Source

Line 21 in breeze/benchmarking/bench_harness.hpp.