% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sobol_generator.R
\name{sobol_generator}
\alias{sobol_generator}
\title{Create a Sobol Sequence Generator}
\usage{
sobol_generator(dimensions, skip = 0)
}
\arguments{
\item{dimensions}{Integer, the number of dimensions for the Sobol sequence.
Must be a positive integer.}

\item{skip}{Numeric, the number of initial points to skip (default: 0).
This allows starting the sequence from any index for reproducibility.}
}
\value{
An S3 object of class "sobol_generator" containing:
  \item{generator}{The underlying Rcpp reference class object}
  \item{dimensions}{Number of dimensions}
  \item{initial_skip}{Initial skip value used at construction}
}
\description{
Creates an S3 object that wraps an Rcpp Sobol sequence generator for
incremental point generation. The generator maintains internal state
and allows for efficient generation of quasi-random sequences.
}
\examples{
# Create a 3-dimensional Sobol generator
gen <- sobol_generator(dimensions = 3)

# Generate a single point
point <- sobol_next(gen)

# Generate multiple points
points <- sobol_next_n(gen, n = 100)

# Skip to a specific index
sobol_skip_to(gen, 1000)

# Create a generator starting from index 50
gen2 <- sobol_generator(dimensions = 2, skip = 50)

}
