genomicSimulationC 0.2.6
Data Fields
gsc_RandomAccessIterator Struct Reference

A structure to search and cache indexes of all genotypes in a gsc_SimData or of all the members of a group. More...

#include <sim-operations.h>

+ Collaboration diagram for gsc_RandomAccessIterator:

Data Fields

gsc_SimDatad
 Simulation data through which to iterate. More...
 
const gsc_GroupNum group
 Group through which to iterate. More...
 
unsigned int cacheSize
 Length in gsc_GenoLocations of cache More...
 
gsc_GenoLocationcache
 Array iteratively updated with the known genotypes in the simulation that fulfil the group criteria of the iterator as they are discovered during calls to next_ functions. More...
 
unsigned int largestCached
 Local/group index (that is, index in cache) of the highest cell in cache that has been filled. More...
 
unsigned int groupSize
 If the number of genotypes in the simulation that fulfil the iterator's group criteria is known, it is saved here. More...
 

Detailed Description

A structure to search and cache indexes of all genotypes in a gsc_SimData or of all the members of a group.

See also
gsc_create_randomaccess_iter

Has short name: RandomAccessIterator

Definition at line 1308 of file sim-operations.h.

Field Documentation

◆ cache

gsc_GenoLocation* gsc_RandomAccessIterator::cache

Array iteratively updated with the known genotypes in the simulation that fulfil the group criteria of the iterator as they are discovered during calls to next_ functions.

Definition at line 1316 of file sim-operations.h.

◆ cacheSize

unsigned int gsc_RandomAccessIterator::cacheSize

Length in gsc_GenoLocations of cache

Definition at line 1315 of file sim-operations.h.

◆ d

gsc_SimData* gsc_RandomAccessIterator::d

Simulation data through which to iterate.

Definition at line 1309 of file sim-operations.h.

◆ group

const gsc_GroupNum gsc_RandomAccessIterator::group

Group through which to iterate.

If it is 0, then iterate through all genotypes in the simulation. Otherwise, iterate through members of the group with this as their group number.

Definition at line 1310 of file sim-operations.h.

◆ groupSize

unsigned int gsc_RandomAccessIterator::groupSize

If the number of genotypes in the simulation that fulfil the iterator's group criteria is known, it is saved here.

This value is left uninitialised until then.

Definition at line 1323 of file sim-operations.h.

◆ largestCached

unsigned int gsc_RandomAccessIterator::largestCached

Local/group index (that is, index in cache) of the highest cell in cache that has been filled.

Definition at line 1321 of file sim-operations.h.


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