tudocomp
– The TU Dortmund Compression Framework
tdc::RandomUniformGenerator Class Reference

Generates a random string of uniformly distributed characters. More...

#include <RandomUniformGenerator.hpp>

Inheritance diagram for tdc::RandomUniformGenerator:
tdc::Generator tdc::Algorithm

Public Member Functions

virtual std::string generate () override
 Generates a string based on the environment settings. More...
 
- Public Member Functions inherited from tdc::Algorithm
virtual ~Algorithm ()=default
 
 Algorithm (Algorithm const &)=default
 
 Algorithm (Algorithm &&)=default
 
Algorithmoperator= (Algorithm const &)=default
 
Algorithmoperator= (Algorithm &&)=default
 
 Algorithm (Env &&env)
 Instantiates an algorithm in the specified environment. More...
 
Envenv ()
 Provides access to the environment that the algorithm works in. More...
 
const Envenv () const
 

Static Public Member Functions

static Meta meta ()
 
static std::string generate (size_t length, size_t seed=0, size_t min='0', size_t max='9')
 

Detailed Description

Generates a random string of uniformly distributed characters.

The range of generated character ASCII codes can be specified using the min and max environment parameters, as well as the seed value for the randomizer.

A seed of zero (default) will result in a seed obtained from the system clock.

Definition at line 17 of file RandomUniformGenerator.hpp.

Member Function Documentation

◆ generate() [1/2]

static std::string tdc::RandomUniformGenerator::generate ( size_t  length,
size_t  seed = 0,
size_t  min = '0',
size_t  max = '9' 
)
inlinestatic

Definition at line 29 of file RandomUniformGenerator.hpp.

◆ generate() [2/2]

virtual std::string tdc::RandomUniformGenerator::generate ( )
inlineoverridevirtual

Generates a string based on the environment settings.

Returns
the generated string.

Implements tdc::Generator.

Definition at line 48 of file RandomUniformGenerator.hpp.

◆ meta()

static Meta tdc::RandomUniformGenerator::meta ( )
inlinestatic

Definition at line 20 of file RandomUniformGenerator.hpp.


The documentation for this class was generated from the following file: