SPH
Public Member Functions | List of all members
VectorRng< TScalarRng > Class Template Reference

Wrapper for generating random vectors. More...

#include <VectorRng.h>

Inheritance diagram for VectorRng< TScalarRng >:
Noncopyable

Public Member Functions

 VectorRng ()
 Default constructor. Can be only used if RNG is owned by the object. More...
 
template<typename... TArgs>
 VectorRng (TArgs &&... args)
 
 VectorRng (VectorRng &&other)
 
VectorRngoperator= (VectorRng &&other)
 
Vector operator() ()
 
Float getAdditional (const Size i)
 
- Public Member Functions inherited from Noncopyable
 Noncopyable ()=default
 
 Noncopyable (const Noncopyable &)=delete
 
 Noncopyable (Noncopyable &&)=default
 
Noncopyableoperator= (const Noncopyable &)=delete
 
Noncopyableoperator= (Noncopyable &&)=default
 

Detailed Description

template<typename TScalarRng>
class VectorRng< TScalarRng >

Wrapper for generating random vectors.

Takes RNG as template parameter, and can either keep reference to other RNG object, or create RNG object of its own.

Definition at line 18 of file VectorRng.h.

Constructor & Destructor Documentation

◆ VectorRng() [1/3]

template<typename TScalarRng >
VectorRng< TScalarRng >::VectorRng ( )
inline

Default constructor. Can be only used if RNG is owned by the object.

Definition at line 24 of file VectorRng.h.

◆ VectorRng() [2/3]

template<typename TScalarRng >
template<typename... TArgs>
VectorRng< TScalarRng >::VectorRng ( TArgs &&...  args)
inlineexplicit

Definition at line 29 of file VectorRng.h.

◆ VectorRng() [3/3]

template<typename TScalarRng >
VectorRng< TScalarRng >::VectorRng ( VectorRng< TScalarRng > &&  other)
inline

Definition at line 32 of file VectorRng.h.

Member Function Documentation

◆ getAdditional()

template<typename TScalarRng >
Float VectorRng< TScalarRng >::getAdditional ( const Size  i)
inline

Generates additional random numbers, can be viewed as extension of vector to more dimensions.

Parameters
iIndex of dimension, must be at least 3 as first three dimensions belong to the vector.

Definition at line 49 of file VectorRng.h.

◆ operator()()

template<typename TScalarRng >
Vector VectorRng< TScalarRng >::operator() ( )
inline

Definition at line 43 of file VectorRng.h.

◆ operator=()

template<typename TScalarRng >
VectorRng& VectorRng< TScalarRng >::operator= ( VectorRng< TScalarRng > &&  other)
inline

Definition at line 37 of file VectorRng.h.


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