C++ API Reference

Class Hierarchy

• • Namespace prng
    • Namespace prng::internal
      • Template Struct ChaChaSIMDInitFunctor
      • Struct ChaChaSIMDInitResult
      • Template Struct ChaChaState
      • Template Struct PhiloxConstants
      • Template Struct PhiloxConstants< 2, 32 >
      • Template Struct PhiloxConstants< 2, 64 >
      • Template Struct PhiloxConstants< 4, 32 >
      • Template Struct PhiloxConstants< 4, 64 >
      • Template Struct PhiloxSIMDInitFunctor
      • Template Struct PhiloxSIMDInitResult
      • Template Struct PhiloxState
      • Struct XoshiroSIMDInitFunctor
      • Struct XoshiroSIMDInitResult
      • Template Struct XoshiroState
    • Template Class ChaCha
    • Template Class ChaChaNative
    • Template Class ChaChaSIMD
      • Struct ChaChaSIMD::StateStorage
    • Template Class Philox
    • Template Class PhiloxNative
    • Template Class PhiloxSIMD
      • Struct PhiloxSIMD::StateStorage
    • Class SplitMix
    • Class XoshiroNative
    • Class XoshiroScalar
    • Class XoshiroSIMD
      • Struct XoshiroSIMD::StateStorage

File Hierarchy

• • File chacha.hpp
  • File chacha_simd.hpp
  • File dispatch_arch.hpp
  • File macros.hpp
  • File philox.hpp
  • File philox_simd.hpp
  • File splitmix.hpp
  • File xoshiro.hpp
  • File xoshiro_scalar.hpp
  • File xoshiro_simd.hpp

Full API

Namespaces

• Namespace prng
  • Namespaces
  • Classes
  • Typedefs

• Namespace prng::internal
  • Classes

Classes and Structs

• Struct ChaChaSIMD::StateStorage
  • Nested Relationships
  • Struct Documentation
    • prng::ChaChaSIMD::StateStorage
      • data
      • SIZE
      • ALIGN

• Template Struct ChaChaSIMDInitFunctor
  • Struct Documentation
    • prng::internal::ChaChaSIMDInitFunctor
      • operator()()
      • state_storage
      • key
      • counter
      • nonce

• Struct ChaChaSIMDInitResult
  • Struct Documentation
    • prng::internal::ChaChaSIMDInitResult
      • matrix_type
      • next_block_fn
      • get_state_fn
      • set_state_fn
      • get_cache_index_fn
      • next_block
      • get_state
      • set_state
      • get_cache_index
      • simd_size

• Template Struct ChaChaState
  • Struct Documentation
    • prng::internal::ChaChaState
      • input_word
      • matrix_word
      • matrix_type
      • simd_type
      • working_state_type
      • cache_block_type
      • cache_batch_type
      • ChaChaState()
      • getState()
      • next_block()
      • m_state
      • m_cache
      • m_cache_index
      • cache_batchcount()
      • MATRIX_WORDCOUNT
      • KEY_WORDCOUNT
      • SIMD_WIDTH
      • SIMD_WIDTH_SHIFT
      • SIMD_WIDTH_MASK
      • BLOCK_SEGMENTCOUNT
      • CACHE_BATCHCOUNT
      • CACHE_BLOCKCOUNT

• Template Struct PhiloxConstants
  • Struct Documentation
    • prng::internal::PhiloxConstants

• Template Struct PhiloxConstants< 2, 32 >
  • Struct Documentation
    • prng::internal::PhiloxConstants< 2, 32 >
      • M0
      • W0

• Template Struct PhiloxConstants< 2, 64 >
  • Struct Documentation
    • prng::internal::PhiloxConstants< 2, 64 >
      • M0
      • W0

• Template Struct PhiloxConstants< 4, 32 >
  • Struct Documentation
    • prng::internal::PhiloxConstants< 4, 32 >
      • M0
      • M1
      • W0
      • W1

• Template Struct PhiloxConstants< 4, 64 >
  • Struct Documentation
    • prng::internal::PhiloxConstants< 4, 64 >
      • M0
      • M1
      • W0
      • W1

• Template Struct PhiloxSIMDInitFunctor
  • Struct Documentation
    • prng::internal::PhiloxSIMDInitFunctor
      • word_type
      • counter_type
      • key_type
      • operator()()
      • state_storage
      • key
      • counter

• Template Struct PhiloxSIMDInitResult
  • Struct Documentation
    • prng::internal::PhiloxSIMDInitResult
      • word_type
      • counter_type
      • key_type
      • result_type
      • populate_fn
      • get_counter_fn
      • get_raw_counter_fn
      • get_key_fn
      • set_state_fn
      • populate_cache
      • get_counter
      • get_raw_counter
      • get_key
      • set_state
      • simd_size
      • CACHE_SIZE

• Template Struct PhiloxState
  • Struct Documentation
    • prng::internal::PhiloxState
      • word_type
      • counter_type
      • key_type
      • result_type
      • simd_type
      • PhiloxState()
      • populate_cache()
      • getCounter()
      • getRawCounter()
      • getKey()
      • setState()
      • m_counter
      • m_key
      • RESULTS_PER_BLOCK
      • SIMD_WIDTH
      • CACHE_SIZE
      • BLOCKS_PER_CACHE
      • BATCHES_PER_CACHE

• Struct XoshiroSIMDInitFunctor
  • Struct Documentation
    • prng::internal::XoshiroSIMDInitFunctor
      • operator()()
      • state_storage
      • seed
      • thread_id
      • cluster_id

• Struct XoshiroSIMDInitResult
  • Struct Documentation
    • prng::internal::XoshiroSIMDInitResult
      • populate_fn
      • jump_fn
      • get_state_fn
      • set_state_fn
      • simd_width_fn
      • populate_cache
      • jump
      • mid_jump
      • long_jump
      • get_state
      • set_state
      • simd_width

• Template Struct XoshiroState
  • Struct Documentation
    • prng::internal::XoshiroState
      • result_type
      • simd_type
      • seed()
      • next()
      • populate_cache()
      • jump()
      • mid_jump()
      • long_jump()
      • getState()
      • get_flat_state()
      • set_flat_state()
      • s
      • RNG_WIDTH
      • SIMD_WIDTH
      • CACHE_SIZE

• Struct PhiloxSIMD::StateStorage
  • Nested Relationships
  • Struct Documentation
    • prng::PhiloxSIMD::StateStorage
      • data
      • SIZE
      • ALIGN

• Struct XoshiroSIMD::StateStorage
  • Nested Relationships
  • Struct Documentation
    • prng::XoshiroSIMD::StateStorage
      • data
      • SIZE
      • ALIGN

• Template Class ChaCha
  • Class Documentation
    • prng::ChaCha
      • result_type
      • input_word
      • matrix_word
      • matrix_type
      • result_cache_type
      • ChaCha()
      • uniform()
      • block()
      • getState()
      • MATRIX_WORDCOUNT
      • KEY_WORDCOUNT

• Template Class ChaChaNative
  • Class Documentation
    • prng::ChaChaNative
      • result_type
      • input_word
      • matrix_word
      • matrix_type
      • result_cache_type
      • ChaChaNative()
      • ChaChaNative()
      • operator()()
      • uniform()
      • block()
      • getState()
      • getStateForSerde()
      • setState()
      • result_cache()
      • set_result_cache()
      • result_index()
      • set_result_index()
      • getSIMDSize()
      • MATRIX_WORDCOUNT
      • KEY_WORDCOUNT

• Template Class ChaChaSIMD
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • prng::ChaChaSIMD
      • result_type
      • input_word
      • matrix_word
      • matrix_type
      • result_cache_type
      • ChaChaSIMD()
      • ChaChaSIMD()
      • operator()()
      • uniform()
      • block()
      • getState()
      • getStateForSerde()
      • setState()
      • result_cache()
      • set_result_cache()
      • result_index()
      • set_result_index()
      • getSIMDSize()
      • results_to_block()
      • block_to_results()
      • seed_to_key()
      • MATRIX_WORDCOUNT
      • KEY_WORDCOUNT

• Template Class Philox
  • Class Documentation
    • prng::Philox
      • result_type
      • word_type
      • counter_type
      • key_type
      • result_block_type
      • Philox()
      • Philox()
      • operator()()
      • uniform()
      • getCounter()
      • getKey()
      • setCounter()
      • setKey()
      • getCounterForSerde()
      • setState()
      • result_cache()
      • set_result_cache()
      • result_index()
      • set_result_index()
      • seed_to_key()
      • counter_from_uint64()
      • RESULTS_PER_BLOCK

• Template Class PhiloxNative
  • Class Documentation
    • prng::PhiloxNative
      • result_type
      • word_type
      • counter_type
      • key_type
      • PhiloxNative()
      • PhiloxNative()
      • operator()()
      • uniform()
      • getCounter()
      • getKey()
      • getCounterForSerde()
      • setState()
      • cache_index()
      • set_cache_index()
      • cache()
      • cache()
      • getSIMDSize()
      • CACHE_SIZE

• Template Class PhiloxSIMD
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • prng::PhiloxSIMD
      • result_type
      • word_type
      • counter_type
      • key_type
      • PhiloxSIMD()
      • PhiloxSIMD()
      • operator()()
      • uniform()
      • getCounter()
      • getKey()
      • getCounterForSerde()
      • setState()
      • cache_index()
      • set_cache_index()
      • cache()
      • cache()
      • getSIMDSize()
      • seed_to_key()
      • counter_from_uint64()
      • CACHE_SIZE

• Class SplitMix
  • Class Documentation
    • prng::SplitMix
      • SplitMix()
      • operator()()
      • getState()
      • setState()

• Class XoshiroNative
  • Class Documentation
    • prng::XoshiroNative
      • result_type
      • XoshiroNative()
      • XoshiroNative()
      • XoshiroNative()
      • operator()()
      • uniform()
      • getState()
      • jump()
      • mid_jump()
      • long_jump()
      • get_flat_state()
      • set_flat_state()
      • cache_index()
      • set_cache_index()
      • cache()
      • cache()
      • stateSize()
      • simd_width()

• Class XoshiroScalar
  • Class Documentation
    • prng::XoshiroScalar
      • result_type
      • XoshiroScalar()
      • XoshiroScalar()
      • XoshiroScalar()
      • getState()
      • setState()
      • jump()
      • mid_jump()
      • long_jump()
      • stateSize()

• Class XoshiroSIMD
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • prng::XoshiroSIMD
      • result_type
      • XoshiroSIMD()
      • operator()()
      • uniform()
      • jump()
      • mid_jump()
      • long_jump()
      • get_flat_state()
      • set_flat_state()
      • simd_width()
      • cache_index()
      • set_cache_index()
      • cache()
      • cache()
      • populate_fn
      • jump_fn
      • get_state_fn
      • set_state_fn
      • simd_width_fn
      • m_cache
      • m_state
      • m_populate_cache
      • m_jump
      • m_mid_jump
      • m_long_jump
      • m_get_state
      • m_set_state
      • m_simd_width
      • m_index
      • CACHE_SIZE
      • prng::XoshiroSIMD::StateStorage
        • data
        • SIZE
        • ALIGN

Defines

• Define PRNG_ALWAYS_INLINE
  • Define Documentation
    • PRNG_ALWAYS_INLINE

• Define PRNG_CHACHA_EXTERN_TEMPLATE
  • Define Documentation
    • PRNG_CHACHA_EXTERN_TEMPLATE

• Define PRNG_EXPORT
  • Define Documentation
    • PRNG_EXPORT

• Define PRNG_FLATTEN
  • Define Documentation
    • PRNG_FLATTEN

• Define PRNG_NEVER_INLINE
  • Define Documentation
    • PRNG_NEVER_INLINE

• Define PRNG_PHILOX_EXTERN_TEMPLATE
  • Define Documentation
    • PRNG_PHILOX_EXTERN_TEMPLATE

• Define PRNG_PHILOX_EXTERN_TEMPLATES_FOR_ARCH
  • Define Documentation
    • PRNG_PHILOX_EXTERN_TEMPLATES_FOR_ARCH

• Define PRNG_RESTRICT
  • Define Documentation
    • PRNG_RESTRICT

Typedefs

• Typedef prng::ChaCha12Native
  • Typedef Documentation
    • ChaCha12Native

• Typedef prng::ChaCha12SIMD
  • Typedef Documentation
    • ChaCha12SIMD

• Typedef prng::ChaCha20Native
  • Typedef Documentation
    • ChaCha20Native

• Typedef prng::ChaCha20SIMD
  • Typedef Documentation
    • ChaCha20SIMD

• Typedef prng::ChaCha8Native
  • Typedef Documentation
    • ChaCha8Native

• Typedef prng::ChaCha8SIMD
  • Typedef Documentation
    • ChaCha8SIMD

• Typedef prng::dispatch_arch_list
  • Typedef Documentation
    • dispatch_arch_list

• Typedef prng::Philox2x32
  • Typedef Documentation
    • Philox2x32

• Typedef prng::Philox2x32Native
  • Typedef Documentation
    • Philox2x32Native

• Typedef prng::Philox2x32SIMD
  • Typedef Documentation
    • Philox2x32SIMD

• Typedef prng::Philox2x64
  • Typedef Documentation
    • Philox2x64

• Typedef prng::Philox2x64Native
  • Typedef Documentation
    • Philox2x64Native

• Typedef prng::Philox2x64SIMD
  • Typedef Documentation
    • Philox2x64SIMD

• Typedef prng::Philox4x32
  • Typedef Documentation
    • Philox4x32

• Typedef prng::Philox4x32Native
  • Typedef Documentation
    • Philox4x32Native

• Typedef prng::Philox4x32SIMD
  • Typedef Documentation
    • Philox4x32SIMD

• Typedef prng::Philox4x64
  • Typedef Documentation
    • Philox4x64

• Typedef prng::Philox4x64Native
  • Typedef Documentation
    • Philox4x64Native

• Typedef prng::Philox4x64SIMD
  • Typedef Documentation
    • Philox4x64SIMD

• Typedef prng::rvv128
  • Typedef Documentation
    • rvv128

• Typedef prng::Xoshiro
  • Typedef Documentation
    • Xoshiro