Namespace breeze

Description

The library's top-level namespace.

Namespaces

adl_shieldInternal namespace for facilities that must be protected from ADL.
metaNamespace for our meta-programming facilities.

Classes

array_pointerA smart pointer to an array object.
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_policyA policy for our timer 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, as used by Ethernet, Serial ATA, PKZIP, Gzip, Bzip2, PNG.
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).
exact_width_integerProvides, if available, an integer type with width width.
exact_width_unsigned_integerA synonym of exact_width_integer< width, unsigned > .
hashing_countCount policy for the hashing algorithms.
inserterA helper class for writing stream inserters that output directly through the streambuf.
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_policyA timer policy using Windows' QueryPerformanceCounter().
printable_stringA string with non-printable chars escaped.
programA singleton class to manage the overall status of the program and its termination.
romanA Roman numeral.
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_engineSHA-512 policy class for merkle_damgard_machine.
steady_clock_policyA policy for our timer template using std::chrono::steady_clock.
stream_buffer_wrapperWrapper for a stream buffer.
stream_equivalentWrapper for an "equivalent" of a stream.
subrange_adaptorRandom or pseudo-random number generator adaptor.
timerA policy-based timer class (class template).
uuidA universally unique identifier.
windows_version_infoMicrosoft Windows version information.

Functions

as_non_constantMakes an expression non-constant.
base64_to_binaryDecodes a Base64 representation.
base_file_nameReturns: The file name part of a path
begin overloadReturns: The same as c.begin(), for any standard container.
begin overloadLike container::begin(), but for a built-in array.
begins_with overloadReturns: Whether s begins with with
begins_with overloadReturns: true if and only if s begins with c; i.e
binary_to_base64Converts a binary sequence to Base64
bit_castCopies 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 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.
clamp overloadAn implementation of the clamp() templates introduced in C++17.
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()
endian_storeConvenience wrapper around endian_codec::encode()
ends_with overloadReturns: Whether s ends with with
ends_with overloadReturns: true if and only if s ends with c, i.e
eof_valueReturns: The end-of-file value for the given Stream.
file_name_extensionReturns: The extension of the file name part of path, including the period, if any
format_timeReturns: The time corresponding to time_stamp, formatted according to format
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_variablesReturns: A map with all name-value pairs corresponding to the defined environment variables.
get_amount_of_physical_memoryReturns: 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_current_directoryGets the current directory of the calling process.
get_directory_separatorsReturns: A pointer to a C string with static storage duration containing the directory separators allowed in the system
get_environment_variableSearches 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_idReturns the operating_system_id of the running operating system (Windows only).
has_luhn_sumReturns: Whether the given string has a Luhn sum as its last character.
integer_log2Calculates the integer part of the logarithm, to base 2, of its argument.
is_eof_valueReturns: Whether x equals the eof value for the Stream given as the second argument.
is_power_of_2Returns: true if an only if x is a power of two.
lcmReturns the least common multiple of two integers.
levenshtein_distanceReturns: The Levenshtein distance between first and second.
luhn_check_digitReturns: The Luhn checksum digit for the given string
luhn_sumReturns: The Luhn sum of the given string
make_digestConvenience function to create a digest from a Hasher (can use type deduction).
max_for_subrangeReturns: 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<< overloadStream inserter for crc objects.
operator<< overloadOutputs a hexadecimal representation of the digest
operator<< overloadStream inserter for operating_system_name
operator<< overloadStream 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_countReturns: The number of on bits in the binary representation of the value of t
readable_type_name overloadReturns: A human readable name for the type T.
readable_type_name overloadReturns: A human readable name for the type of the object to which ref refers
remove_from_end overloadReturns: 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 overloadReturns: If s ends with c, s with the last character removed; otherwise a copy of s.
replace_allReplaces all occurrences of from in s with to
representation_in_baseReturns: The representation, in base base, of the integer n
require_type_completenessTo be used to ensure that T is a complete type at the point of instantiation
secure_fill overloadLike std::fill(), but guarantees that the range is written to.
secure_fill overloadVersion for built-in arrays.
set_assert_handlerSets *f as the current "assert handler", i.e
set_current_directorySets the current directory of the calling process to dir; dir must be a valid directory path.
signed_count overloadArrays and containers element counter.
splitReturns: A vector of strings obtained by splitting s at each character present in separators, in order.
split_ifReturns: A vector of strings obtained by splitting s at each character which satisfies the predicate pred, in order.
tailReturns: If count >= s.length(), s; otherwise the string composed of the last count characters of s (an empty string if count == 0).
to_lowercaseConverts each character in source to lowercase, using the ctype facet of the given locale
to_string overloadConverts an operating_system_id to a std::string
to_string overloadReturns: The textual representation of its argument
to_uppercaseConverts each character in source to uppercase, using the ctype facet of the given locale
trim overloadReturns: 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 overloadReturns: 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 overloadReturns: A string obtained from s by removing all the leading characters c for which std::isspace( c, loc ) returns true.
trim_head overloadReturns: A string obtained from s by removing all the leading characters that are also contained in to_be_removed.
trim_head_ifReturns: A string obtained from s by removing all the leading characters that satisfy the predicate pred.
trim_ifReturns: A string obtained from s by removing all the leading and all the trailing characters that satisfy the predicate pred.
trim_tail overloadReturns: A string obtained from s by removing all the trailing characters c for which std::isspace( c, loc ) returns true.
trim_tail overloadReturns: A string obtained from s by removing all the trailing characters that are also contained in to_be_removed.
trim_tail_ifReturns: A string obtained from s by removing all the trailing characters that satisfy the predicate pred.
volatilizeAdds a volatile qualification to an lvalue expression, if it doesn't have one.

Enums

operating_system_idOperating system identifier for Windows.
time_kindThe 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::strings, 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.