AliasSampler_3D_t

type, public :: AliasSampler_3D_t

Components

Type	Visibility	Attributes		Name
type(AliasSampler_t),	private,	allocatable	::	samplerArray(:,:,:)
type(shared_array_real_t),	private		::	allProbs
type(shared_array_real_t),	private		::	allBiasTable
type(shared_array_int32_t),	private		::	allAliasTable

Type-Bound Procedures

procedure, public :: shared_alloc => setupSamplerArray_3D

private subroutine setupSamplerArray_3D(this, dims, entry_size, name)

Setup an array of samplers using a single shared resource (split into parts associated with one of them each). This only does the allocation.

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(inout)	::	this
integer,	intent(in)	::	dims(3)
integer,	intent(in)	::	entry_size	number of values per sampler
character(len=*),	intent(in)	::	name

procedure, public :: setup_entry => setupEntry_3D

private subroutine setupEntry_3D(this, i, j, k, rank_with_info, arr)

@brief Initialise one sampler of an array

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(inout)	::	this
integer,	intent(in)	::	i	Index of the entry to initialize
integer,	intent(in)	::	j	Index of the entry to initialize Index of the entry to initialize
integer,	intent(in)	::	k	Index of the entry to initialize Index of the entry to initialize Index of the entry to initialize
integer,	intent(in)	::	rank_with_info	The intra-node rank that contains the weights to be used all other arr of all other ranks are ignored (and can be allocated with size 0).
real(kind=dp),	intent(in)	::	arr(:)

procedure, public :: finalize => samplerArrayDestructor_3D

private subroutine samplerArrayDestructor_3D(this)

@brief Deallocate an array of samplers

Arguments

Type	Intent	Optional	Attributes		Name
class(AliasSampler_3D_t),	intent(inout)			::	this

procedure, public :: sample => aSample_3D

private subroutine aSample_3D(this, i, j, k, tgt, prob)

Draw a random element from 1:size(this%probs) with the probabilities listed in prob

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	The index of the sampler.
integer,	intent(in)	::	j	The index of the sampler.
integer,	intent(in)	::	k	The index of the sampler.
integer,	intent(out)	::	tgt	The sampled value `tgt`.
real(kind=dp),	intent(out)	::	prob	The probability of sampling `tgt`.

generic, public :: constrained_sample => constrained_sample_3D_nI, constrained_sample_3D_fast

private subroutine constrained_sample_3D_nI(this, i, j, k, contain, renorm, pos, tgt, prob)

Draw a random element from 1:size(this%probs) with the probabilities listed in prob while adherring to constraints

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	The index of the sampler.
integer,	intent(in)	::	j	The index of the sampler.
integer,	intent(in)	::	k	The index of the sampler.
integer,	intent(in)	::	contain(:)	The constraint in nI format.
real(kind=dp),	intent(in)	::	renorm	The renormalization. (i.e. sum(this%get_prob(… contain…))
integer,	intent(out)	::	pos	The sampled value `tgt` and its position `pos` in `contain.
integer,	intent(out)	::	tgt	The sampled value `tgt` and its position `pos` in `contain.
real(kind=dp),	intent(out)	::	prob	The probability of sampling `tgt` from `contain`

private subroutine constrained_sample_3D_fast(this, i, j, k, contain, contain_ilut, renormalization, pos, tgt, prob)

Draw a random element from 1:size(this%probs) with the probabilities listed in prob while adherring to constraints

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	The index of the sampler.
integer,	intent(in)	::	j	The index of the sampler.
integer,	intent(in)	::	k	The index of the sampler.
integer,	intent(in)	::	contain(:)	The constraint in nI format.
integer(kind=n_int),	intent(in)	::	contain_ilut(0:)	The constraint in ilut (bitmask) format
real(kind=dp),	intent(in)	::	renormalization	The renormalization. (i.e. sum(this%get_prob(… contain…))
integer,	intent(out)	::	pos	The sampled value `tgt` and its position `pos` in `contain.
integer,	intent(out)	::	tgt	The sampled value `tgt` and its position `pos` in `contain.
real(kind=dp),	intent(out)	::	prob	The probability of sampling `tgt` from `contain`

procedure, private :: constrained_sample_3D_fast

private subroutine constrained_sample_3D_fast(this, i, j, k, contain, contain_ilut, renormalization, pos, tgt, prob)

Draw a random element from 1:size(this%probs) with the probabilities listed in prob while adherring to constraints

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	The index of the sampler.
integer,	intent(in)	::	j	The index of the sampler.
integer,	intent(in)	::	k	The index of the sampler.
integer,	intent(in)	::	contain(:)	The constraint in nI format.
integer(kind=n_int),	intent(in)	::	contain_ilut(0:)	The constraint in ilut (bitmask) format
real(kind=dp),	intent(in)	::	renormalization	The renormalization. (i.e. sum(this%get_prob(… contain…))
integer,	intent(out)	::	pos	The sampled value `tgt` and its position `pos` in `contain.
integer,	intent(out)	::	tgt	The sampled value `tgt` and its position `pos` in `contain.
real(kind=dp),	intent(out)	::	prob	The probability of sampling `tgt` from `contain`

procedure, private :: constrained_sample_3D_nI

private subroutine constrained_sample_3D_nI(this, i, j, k, contain, renorm, pos, tgt, prob)

Draw a random element from 1:size(this%probs) with the probabilities listed in prob while adherring to constraints

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	The index of the sampler.
integer,	intent(in)	::	j	The index of the sampler.
integer,	intent(in)	::	k	The index of the sampler.
integer,	intent(in)	::	contain(:)	The constraint in nI format.
real(kind=dp),	intent(in)	::	renorm	The renormalization. (i.e. sum(this%get_prob(… contain…))
integer,	intent(out)	::	pos	The sampled value `tgt` and its position `pos` in `contain.
integer,	intent(out)	::	tgt	The sampled value `tgt` and its position `pos` in `contain.
real(kind=dp),	intent(out)	::	prob	The probability of sampling `tgt` from `contain`

procedure, public :: get_prob => aGetProb_3D

private elemental function aGetProb_3D(this, i, j, k, tgt) result(prob)

Returns the probability to draw tgt from the sampler with index iEntry

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	Index of the sampler to use
integer,	intent(in)	::	j	Index of the sampler to use Index of the sampler to use
integer,	intent(in)	::	k	Index of the sampler to use Index of the sampler to use Index of the sampler to use
integer,	intent(in)	::	tgt	the number for which we request the probability of sampling

Return Value real(kind=dp)

procedure, public :: constrained_getProb => constrained_get_prob_3D

private pure function constrained_get_prob_3D(this, i, j, k, contain, renorm, tgt) result(prob)

Returns the probability to draw tgt from the sampler with index iEntry

Arguments

Type	Intent		Name
class(AliasSampler_3D_t),	intent(in)	::	this
integer,	intent(in)	::	i	Index of the sampler to use
integer,	intent(in)	::	j	Index of the sampler to use Index of the sampler to use
integer,	intent(in)	::	k	Index of the sampler to use Index of the sampler to use Index of the sampler to use
integer,	intent(in)	::	contain(:)
real(kind=dp),	intent(in)	::	renorm
integer,	intent(in)	::	tgt	the number for which we request the probability of sampling

Return Value real(kind=dp)

procedure, public :: get_memory_demand => get_memory_demand_AliasSampler_3D_t

private elemental function get_memory_demand_AliasSampler_3D_t(this) result(res)

Arguments

Type	Intent	Optional	Attributes		Name
class(AliasSampler_3D_t),	intent(in)			::	this

Return Value type(ByteSize_t)

Source Code

    type AliasSampler_3D_t
        private
        ! this is an array of aliasSamplers, in the end
        type(AliasSampler_t), allocatable :: samplerArray(:, :, :)

        ! shared resources of the array entries
        type(shared_array_real_t) :: allProbs
        type(shared_array_real_t) :: allBiasTable
        type(shared_array_int32_t) :: allAliasTable
    contains
        ! constructor
        procedure :: shared_alloc => setupSamplerArray_3D
        procedure :: setup_entry => setupEntry_3D
        ! destructor
        procedure :: finalize => samplerArrayDestructor_3D
        ! get a random element and the generation probability from one of the samplers
        procedure :: sample => aSample_3D
        generic :: constrained_sample => constrained_sample_3D_nI, constrained_sample_3D_fast
        procedure, private :: constrained_sample_3D_nI, constrained_sample_3D_fast
        procedure :: get_prob => aGetProb_3D
        procedure :: constrained_getProb => constrained_get_prob_3D
        procedure, public :: get_memory_demand => get_memory_demand_AliasSampler_3D_t
    end type AliasSampler_3D_t

AliasSampler_3D_t Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public :: AliasSampler_3D_t

Components

Type-Bound Procedures

procedure, public :: shared_alloc => setupSamplerArray_3D

private subroutine setupSamplerArray_3D(this, dims, entry_size, name)

Arguments

procedure, public :: setup_entry => setupEntry_3D

private subroutine setupEntry_3D(this, i, j, k, rank_with_info, arr)

Arguments

procedure, public :: finalize => samplerArrayDestructor_3D

private subroutine samplerArrayDestructor_3D(this)

Arguments

procedure, public :: sample => aSample_3D

private subroutine aSample_3D(this, i, j, k, tgt, prob)

Arguments

generic, public :: constrained_sample => constrained_sample_3D_nI, constrained_sample_3D_fast

private subroutine constrained_sample_3D_nI(this, i, j, k, contain, renorm, pos, tgt, prob)

Arguments

private subroutine constrained_sample_3D_fast(this, i, j, k, contain, contain_ilut, renormalization, pos, tgt, prob)

Arguments

procedure, private :: constrained_sample_3D_fast

private subroutine constrained_sample_3D_fast(this, i, j, k, contain, contain_ilut, renormalization, pos, tgt, prob)

Arguments

procedure, private :: constrained_sample_3D_nI

private subroutine constrained_sample_3D_nI(this, i, j, k, contain, renorm, pos, tgt, prob)

Arguments

procedure, public :: get_prob => aGetProb_3D

private elemental function aGetProb_3D(this, i, j, k, tgt) result(prob)

Arguments

Return Value real(kind=dp)

procedure, public :: constrained_getProb => constrained_get_prob_3D

private pure function constrained_get_prob_3D(this, i, j, k, contain, renorm, tgt) result(prob)

Arguments

Return Value real(kind=dp)

procedure, public :: get_memory_demand => get_memory_demand_AliasSampler_3D_t

private elemental function get_memory_demand_AliasSampler_3D_t(this) result(res)

Arguments

Return Value type(ByteSize_t)

Source Code