FSobol

Support for Sobol quasi-random numbers

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/Sobol.h

Include

#include "Math/Sobol.h"

Syntax

class FSobol

Remarks

Support for Sobol quasi-random numbers

Functions

Name Description

Public function Static

uint16

 

ComputeGPUSpatialSeed

(
    int32 x,
    int32 y,
    int32 Index
)

Return value for GSystemTextures.SobolSampling

Public function Static

float

 

Evaluate

(
    int32 Index,
    int32 Dim,
    int32 Seed
)

Evaluate Sobol number from one of the traditional Sobol dimensions at the given index

Public function Static

FVector2D

 

Evaluate

(
    int32 Index,
    int32 CellBits,
    FIntPoint Cell,
    FIntPoint Seed
)

Evaluate Sobol number from within a 2D cell at given index

Public function Static

FVector

 

Evaluate

(
    int32 Index,
    int32 CellBits,
    FIntVector Cell,
    FIntVector Seed
)

Evaluate Sobol number from within a 3D cell at given index

Public function Static

float

 

Next

(
    int32 Index,
    int32 Dim,
    float Value
)

Evaluate next Sobol number from one of the traditional Sobol dimensions

Public function Static

FVector2D

 

Next

(
    int32 Index,
    int32 CellBits,
    FVector2D Value
)

Evaluate next Sobol number from within a 2D cell

Public function Static

FVector

 

Next

(
    int32 Index,
    int32 CellBits,
    FVector Value
)

Evaluate next Sobol number from within a 3D cell

Constants

Name

Description

Cell2DDirectionNumbers

24-bit Sobol direction numbers per cell

Cell2DGrayNumbers

24-bit Sobol direction numbers per cell in Gray-code order

Cell3DDirectionNumbers

24-bit Sobol direction numbers per cell

Cell3DGrayNumbers

24-bit Sobol direction numbers per cell in Gray-code order

DirectionNumbers

24-bit Sobol direction numbers for 32-bit index

GrayNumbers

24-bit Sobol direction numbers for Gray code order

MaxCell2DBits

Maximum number of bits in a 2D cell coordinate allows cell grids from 1x1 to 2^MaxCell2DBits x 2^MaxCell2DBits

MaxCell3DBits

Maximum number of bits in a 3D cell coordinate allows cell grids from 1x1x1 to 2^MaxCell3DBits x 2^MaxCell3DBits x 2^MaxCell3DBits

MaxDimension

Number of Sobol dimensions in DirectionNumbers and GrayNumbers tables (full Joe and Kuo table is 21201)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss