From 1168a4c31265b61f86b9097cdaa6b78360499e17 Mon Sep 17 00:00:00 2001 From: Michel Lang Date: Fri, 5 Aug 2022 14:08:03 +0200 Subject: [PATCH] Release v0.10.0 (#369) --- DESCRIPTION | 4 +- NEWS.md | 5 +- README.Rmd | 2 +- README.md | 13 ++-- man/Condition.Rd | 36 +++++------ man/Design.Rd | 30 ++++----- man/Param.Rd | 60 +++++++++--------- man/ParamDbl.Rd | 48 +++++++-------- man/ParamFct.Rd | 44 ++++++------- man/ParamInt.Rd | 48 +++++++-------- man/ParamLgl.Rd | 44 ++++++------- man/ParamSet.Rd | 123 ++++++++++++++++++++++--------------- man/ParamSetCollection.Rd | 71 ++++++++++----------- man/ParamUty.Rd | 44 ++++++------- man/Sampler.Rd | 30 ++++----- man/Sampler1D.Rd | 34 +++++----- man/Sampler1DCateg.Rd | 34 +++++----- man/Sampler1DNormal.Rd | 34 +++++----- man/Sampler1DRfun.Rd | 34 +++++----- man/Sampler1DUnif.Rd | 34 +++++----- man/SamplerHierarchical.Rd | 34 +++++----- man/SamplerJointIndep.Rd | 34 +++++----- man/SamplerUnif.Rd | 34 +++++----- 23 files changed, 454 insertions(+), 420 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index fafe25d6..6905a976 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Type: Package Package: paradox Title: Define and Work with Parameter Spaces for Complex Algorithms -Version: 0.9.0.9000 +Version: 0.10.0 Authors@R: c(person(given = "Michel", family = "Lang", @@ -57,7 +57,7 @@ Config/testthat/edition: 3 Config/testthat/parallel: false NeedsCompilation: no Roxygen: list(markdown = TRUE, r6 = TRUE) -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.1 Collate: 'Condition.R' 'Design.R' diff --git a/NEWS.md b/NEWS.md index ff91783d..116e3e2a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,8 @@ -# paradox 0.9.0.9000 +# paradox 0.10.0 * Reset `.has_extra_trafo` to `FALSE` when trafo is set to `NULL`. -* Add method set_values to conveniently add parameter values. +* `rd_info.ParamSet` collapses vector with `"\n"` due changes in roxygen 7.2.0 +* Add method `set_values()` to conveniently add parameter values. # paradox 0.9.0 diff --git a/README.Rmd b/README.Rmd index b8b05051..e4d58ee5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -117,4 +117,4 @@ xst = x$transpose() xst ``` -Further documentation can be found in the [mlr3book](https://mlr3book.mlr-org.com/pipelines.html). +Further documentation can be found in the [mlr3book](https://mlr3book.mlr-org.com/05-pipelines.html). diff --git a/README.md b/README.md index a980a643..02ac8540 100644 --- a/README.md +++ b/README.md @@ -140,9 +140,14 @@ Transformations are functions with a fixed signature. - `param_set` the `ParamSet` used to create the design Transformations can be used to change the distributions of sampled -parameters. For example, to sample values between \(2^-3\) and \(2^3\) -in a \(log_2\)-uniform distribution, one can sample uniformly between -3 -and 3 and exponentiate the random value inside the transformation. +parameters. For example, to sample values between +![2^-3](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;2%5E-3 +"2^-3") and +![2^3](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;2%5E3 +"2^3") in a +![log\_2](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;log_2 +"log_2")-uniform distribution, one can sample uniformly between -3 and 3 +and exponentiate the random value inside the transformation. ``` r ps = ParamSet$new( @@ -176,4 +181,4 @@ xst ``` Further documentation can be found in the -[mlr3book](https://mlr3book.mlr-org.com/pipelines.html). +[mlr3book](https://mlr3book.mlr-org.com/05-pipelines.html). diff --git a/man/Condition.Rd b/man/Condition.Rd index e6a456e5..65a58121 100644 --- a/man/Condition.Rd +++ b/man/Condition.Rd @@ -32,17 +32,17 @@ Right-hand-side of the condition.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Condition$new()}} -\item \href{#method-test}{\code{Condition$test()}} -\item \href{#method-as_string}{\code{Condition$as_string()}} -\item \href{#method-format}{\code{Condition$format()}} -\item \href{#method-print}{\code{Condition$print()}} -\item \href{#method-clone}{\code{Condition$clone()}} +\item \href{#method-Condition-new}{\code{Condition$new()}} +\item \href{#method-Condition-test}{\code{Condition$test()}} +\item \href{#method-Condition-as_string}{\code{Condition$as_string()}} +\item \href{#method-Condition-format}{\code{Condition$format()}} +\item \href{#method-Condition-print}{\code{Condition$print()}} +\item \href{#method-Condition-clone}{\code{Condition$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -62,8 +62,8 @@ Right-hand-side of the condition.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-test}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-test}{}}} \subsection{Method \code{test()}}{ Checks if condition is satisfied. Called on a vector of parent param values. @@ -83,8 +83,8 @@ Called on a vector of parent param values. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-as_string}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-as_string}{}}} \subsection{Method \code{as_string()}}{ Conversion helper for print outputs. \subsection{Usage}{ @@ -100,8 +100,8 @@ Conversion helper for print outputs. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-format}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-format}{}}} \subsection{Method \code{format()}}{ Helper for print outputs. \subsection{Usage}{ @@ -110,8 +110,8 @@ Helper for print outputs. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-print}{}}} \subsection{Method \code{print()}}{ Printer. \subsection{Usage}{ @@ -127,8 +127,8 @@ Printer. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Condition-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Design.Rd b/man/Design.Rd index 16c7a5bb..98eccce7 100644 --- a/man/Design.Rd +++ b/man/Design.Rd @@ -21,16 +21,16 @@ Stored \code{data}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Design$new()}} -\item \href{#method-format}{\code{Design$format()}} -\item \href{#method-print}{\code{Design$print()}} -\item \href{#method-transpose}{\code{Design$transpose()}} -\item \href{#method-clone}{\code{Design$clone()}} +\item \href{#method-Design-new}{\code{Design$new()}} +\item \href{#method-Design-format}{\code{Design$format()}} +\item \href{#method-Design-print}{\code{Design$print()}} +\item \href{#method-Design-transpose}{\code{Design$transpose()}} +\item \href{#method-Design-clone}{\code{Design$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Design-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -52,8 +52,8 @@ Remove duplicates?} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-format}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Design-format}{}}} \subsection{Method \code{format()}}{ Helper for print outputs. \subsection{Usage}{ @@ -62,8 +62,8 @@ Helper for print outputs. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Design-print}{}}} \subsection{Method \code{print()}}{ Printer. \subsection{Usage}{ @@ -79,8 +79,8 @@ Printer. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-transpose}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Design-transpose}{}}} \subsection{Method \code{transpose()}}{ Converts \code{data} into a list of lists of row-configurations, possibly removes \code{NA} entries of inactive parameter values due to unsatisfied dependencies, @@ -103,8 +103,8 @@ Should the \code{trafo} function of the \link{ParamSet} be called?} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Design-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Param.Rd b/man/Param.Rd index ad2e81c9..8b4ec49c 100644 --- a/man/Param.Rd +++ b/man/Param.Rd @@ -66,21 +66,21 @@ Is there a default value?} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Param$new()}} -\item \href{#method-check}{\code{Param$check()}} -\item \href{#method-assert}{\code{Param$assert()}} -\item \href{#method-test}{\code{Param$test()}} -\item \href{#method-rep}{\code{Param$rep()}} -\item \href{#method-format}{\code{Param$format()}} -\item \href{#method-print}{\code{Param$print()}} -\item \href{#method-qunif}{\code{Param$qunif()}} -\item \href{#method-convert}{\code{Param$convert()}} -\item \href{#method-clone}{\code{Param$clone()}} +\item \href{#method-Param-new}{\code{Param$new()}} +\item \href{#method-Param-check}{\code{Param$check()}} +\item \href{#method-Param-assert}{\code{Param$assert()}} +\item \href{#method-Param-test}{\code{Param$test()}} +\item \href{#method-Param-rep}{\code{Param$rep()}} +\item \href{#method-Param-format}{\code{Param$format()}} +\item \href{#method-Param-print}{\code{Param$print()}} +\item \href{#method-Param-qunif}{\code{Param$qunif()}} +\item \href{#method-Param-convert}{\code{Param$convert()}} +\item \href{#method-Param-clone}{\code{Param$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. @@ -123,8 +123,8 @@ purpose:\cr } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-check}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-check}{}}} \subsection{Method \code{check()}}{ \pkg{checkmate}-like check-function. Take a value from the domain of the parameter, and check if it is feasible. A value is feasible if it is of @@ -146,8 +146,8 @@ If successful \code{TRUE}, if not a string with the error message. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-assert}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-assert}{}}} \subsection{Method \code{assert()}}{ \pkg{checkmate}-like assert-function. Take a value from the domain of the parameter, and assert if it is feasible. A value is feasible if it @@ -169,8 +169,8 @@ If successful \code{x} invisibly, if not an exception is raised. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-test}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-test}{}}} \subsection{Method \code{test()}}{ \pkg{checkmate}-like test-function. Take a value from the domain of the parameter, and test if it is feasible. A value is feasible if it is of @@ -192,8 +192,8 @@ If successful \code{TRUE}, if not \code{FALSE}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-rep}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-rep}{}}} \subsection{Method \code{rep()}}{ Repeats this parameter n-times (by cloning). Each parameter is named "[id]\emph{rep}[k]" and gets the additional tag "[id]_rep". @@ -213,8 +213,8 @@ Each parameter is named "[id]\emph{rep}[k]" and gets the additional tag "[id]_re } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-format}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-format}{}}} \subsection{Method \code{format()}}{ Helper for print outputs. \subsection{Usage}{ @@ -223,8 +223,8 @@ Helper for print outputs. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-print}{}}} \subsection{Method \code{print()}}{ Printer. \subsection{Usage}{ @@ -247,8 +247,8 @@ Which fields should not be printed? Default is \code{"nlevels"}, } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-qunif}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-qunif}{}}} \subsection{Method \code{qunif()}}{ Takes values from [0,1] and maps them, regularly distributed, to the domain of the parameter. Think of: quantile function or the use case to @@ -270,8 +270,8 @@ Value of the domain of the parameter. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-convert}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-convert}{}}} \subsection{Method \code{convert()}}{ Converts a value to the closest valid param. Only for values that pass \verb{$check()} and mostly used internally. @@ -291,8 +291,8 @@ pass \verb{$check()} and mostly used internally. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Param-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamDbl.Rd b/man/ParamDbl.Rd index f3a50bdb..02a0c5ae 100644 --- a/man/ParamDbl.Rd +++ b/man/ParamDbl.Rd @@ -75,27 +75,27 @@ Always \code{"list"} for \link{ParamUty}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamDbl$new()}} -\item \href{#method-convert}{\code{ParamDbl$convert()}} -\item \href{#method-clone}{\code{ParamDbl$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Param.html#method-assert}{\code{paradox::Param$assert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-check}{\code{paradox::Param$check()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-format}{\code{paradox::Param$format()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-print}{\code{paradox::Param$print()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-qunif}{\code{paradox::Param$qunif()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-rep}{\code{paradox::Param$rep()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-test}{\code{paradox::Param$test()}}\out{} -} -\out{
} -} +\item \href{#method-ParamDbl-new}{\code{ParamDbl$new()}} +\item \href{#method-ParamDbl-convert}{\code{ParamDbl$convert()}} +\item \href{#method-ParamDbl-clone}{\code{ParamDbl$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamDbl-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -152,8 +152,8 @@ Initializes the \verb{$tolerance} field that determines the} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-convert}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamDbl-convert}{}}} \subsection{Method \code{convert()}}{ Restrict the value to within the allowed range. This works in conjunction with \verb{$tolerance}, which accepts values @@ -172,8 +172,8 @@ Value to convert.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamDbl-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamFct.Rd b/man/ParamFct.Rd index fed2a0ad..f27abe83 100644 --- a/man/ParamFct.Rd +++ b/man/ParamFct.Rd @@ -66,27 +66,27 @@ Always \code{"list"} for \link{ParamUty}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamFct$new()}} -\item \href{#method-clone}{\code{ParamFct$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Param.html#method-assert}{\code{paradox::Param$assert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-check}{\code{paradox::Param$check()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-convert}{\code{paradox::Param$convert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-format}{\code{paradox::Param$format()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-print}{\code{paradox::Param$print()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-qunif}{\code{paradox::Param$qunif()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-rep}{\code{paradox::Param$rep()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-test}{\code{paradox::Param$test()}}\out{} -} -\out{
} -} +\item \href{#method-ParamFct-new}{\code{ParamFct$new()}} +\item \href{#method-ParamFct-clone}{\code{ParamFct$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamFct-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -135,8 +135,8 @@ purpose:\cr } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamFct-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamInt.Rd b/man/ParamInt.Rd index 63796507..50647d55 100644 --- a/man/ParamInt.Rd +++ b/man/ParamInt.Rd @@ -71,27 +71,27 @@ Always \code{"list"} for \link{ParamUty}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamInt$new()}} -\item \href{#method-convert}{\code{ParamInt$convert()}} -\item \href{#method-clone}{\code{ParamInt$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Param.html#method-assert}{\code{paradox::Param$assert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-check}{\code{paradox::Param$check()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-format}{\code{paradox::Param$format()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-print}{\code{paradox::Param$print()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-qunif}{\code{paradox::Param$qunif()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-rep}{\code{paradox::Param$rep()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-test}{\code{paradox::Param$test()}}\out{} -} -\out{
} -} +\item \href{#method-ParamInt-new}{\code{ParamInt$new()}} +\item \href{#method-ParamInt-convert}{\code{ParamInt$convert()}} +\item \href{#method-ParamInt-clone}{\code{ParamInt$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamInt-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -144,8 +144,8 @@ purpose:\cr } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-convert}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamInt-convert}{}}} \subsection{Method \code{convert()}}{ Converts a value to an integer. \subsection{Usage}{ @@ -162,8 +162,8 @@ Value to convert.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamInt-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamLgl.Rd b/man/ParamLgl.Rd index 4f8257c3..243d27d1 100644 --- a/man/ParamLgl.Rd +++ b/man/ParamLgl.Rd @@ -61,27 +61,27 @@ Always \code{"list"} for \link{ParamUty}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamLgl$new()}} -\item \href{#method-clone}{\code{ParamLgl$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Param.html#method-assert}{\code{paradox::Param$assert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-check}{\code{paradox::Param$check()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-convert}{\code{paradox::Param$convert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-format}{\code{paradox::Param$format()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-print}{\code{paradox::Param$print()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-qunif}{\code{paradox::Param$qunif()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-rep}{\code{paradox::Param$rep()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-test}{\code{paradox::Param$test()}}\out{} -} -\out{
} -} +\item \href{#method-ParamLgl-new}{\code{ParamLgl$new()}} +\item \href{#method-ParamLgl-clone}{\code{ParamLgl$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamLgl-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -121,8 +121,8 @@ purpose:\cr } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamLgl-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamSet.Rd b/man/ParamSet.Rd index 14fca66c..550b7020 100644 --- a/man/ParamSet.Rd +++ b/man/ParamSet.Rd @@ -166,27 +166,28 @@ Has the set parameter dependencies?} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamSet$new()}} -\item \href{#method-add}{\code{ParamSet$add()}} -\item \href{#method-ids}{\code{ParamSet$ids()}} -\item \href{#method-get_values}{\code{ParamSet$get_values()}} -\item \href{#method-subset}{\code{ParamSet$subset()}} -\item \href{#method-search_space}{\code{ParamSet$search_space()}} -\item \href{#method-check}{\code{ParamSet$check()}} -\item \href{#method-test}{\code{ParamSet$test()}} -\item \href{#method-assert}{\code{ParamSet$assert()}} -\item \href{#method-check_dt}{\code{ParamSet$check_dt()}} -\item \href{#method-test_dt}{\code{ParamSet$test_dt()}} -\item \href{#method-assert_dt}{\code{ParamSet$assert_dt()}} -\item \href{#method-add_dep}{\code{ParamSet$add_dep()}} -\item \href{#method-format}{\code{ParamSet$format()}} -\item \href{#method-print}{\code{ParamSet$print()}} -\item \href{#method-clone}{\code{ParamSet$clone()}} +\item \href{#method-ParamSet-new}{\code{ParamSet$new()}} +\item \href{#method-ParamSet-add}{\code{ParamSet$add()}} +\item \href{#method-ParamSet-ids}{\code{ParamSet$ids()}} +\item \href{#method-ParamSet-get_values}{\code{ParamSet$get_values()}} +\item \href{#method-ParamSet-set_values}{\code{ParamSet$set_values()}} +\item \href{#method-ParamSet-subset}{\code{ParamSet$subset()}} +\item \href{#method-ParamSet-search_space}{\code{ParamSet$search_space()}} +\item \href{#method-ParamSet-check}{\code{ParamSet$check()}} +\item \href{#method-ParamSet-test}{\code{ParamSet$test()}} +\item \href{#method-ParamSet-assert}{\code{ParamSet$assert()}} +\item \href{#method-ParamSet-check_dt}{\code{ParamSet$check_dt()}} +\item \href{#method-ParamSet-test_dt}{\code{ParamSet$test_dt()}} +\item \href{#method-ParamSet-assert_dt}{\code{ParamSet$assert_dt()}} +\item \href{#method-ParamSet-add_dep}{\code{ParamSet$add_dep()}} +\item \href{#method-ParamSet-format}{\code{ParamSet$format()}} +\item \href{#method-ParamSet-print}{\code{ParamSet$print()}} +\item \href{#method-ParamSet-clone}{\code{ParamSet$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -204,8 +205,8 @@ Parameters are cloned.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-add}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-add}{}}} \subsection{Method \code{add()}}{ Adds a single param or another set to this set, all params are cloned. \subsection{Usage}{ @@ -221,8 +222,8 @@ Adds a single param or another set to this set, all params are cloned. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ids}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-ids}{}}} \subsection{Method \code{ids()}}{ Retrieves IDs of contained parameters based on some filter criteria selections, \code{NULL} means no restriction. @@ -247,8 +248,8 @@ Only returns IDs of parameters that satisfy all conditions. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-get_values}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-get_values}{}}} \subsection{Method \code{get_values()}}{ Retrieves parameter values based on some selections, \code{NULL} means no restriction and is equivalent to \verb{$values}. @@ -285,8 +286,34 @@ Named \code{list()}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-subset}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-set_values}{}}} +\subsection{Method \code{set_values()}}{ +Allows to to modify (and overwrite) or replace the parameter values. +Per default already set values are being kept unless new values are being provided. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{ParamSet$set_values(..., .values = list(), .insert = TRUE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{...}}{(any)\cr +Named parameter values.} + +\item{\code{.values}}{(named \code{list()})\cr +Named list with parameter values. Names must not already appear in \code{...}.} + +\item{\code{.insert}}{(\code{logical(1)})\cr +Whether to insert the values (old values are being kept, if not overwritten), or to +replace all values. Default is TRUE.} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-subset}{}}} \subsection{Method \code{subset()}}{ Changes the current set to the set of passed IDs. \subsection{Usage}{ @@ -302,8 +329,8 @@ Changes the current set to the set of passed IDs. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-search_space}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-search_space}{}}} \subsection{Method \code{search_space()}}{ Construct a \code{\link{ParamSet}} to tune over. Constructed from \code{\link{TuneToken}} in \verb{$values}, see \code{\link[=to_tune]{to_tune()}}. \subsection{Usage}{ @@ -319,8 +346,8 @@ Construct a \code{\link{ParamSet}} to tune over. Constructed from \code{\link{Tu } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-check}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-check}{}}} \subsection{Method \code{check()}}{ \pkg{checkmate}-like check-function. Takes a named list. A point x is feasible, if it configures a subset of params, @@ -342,8 +369,8 @@ If successful \code{TRUE}, if not a string with the error message. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-test}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-test}{}}} \subsection{Method \code{test()}}{ \pkg{checkmate}-like test-function. Takes a named list. A point x is feasible, if it configures a subset of params, @@ -365,8 +392,8 @@ If successful \code{TRUE}, if not \code{FALSE}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-assert}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-assert}{}}} \subsection{Method \code{assert()}}{ \pkg{checkmate}-like assert-function. Takes a named list. A point x is feasible, if it configures a subset of params, @@ -392,8 +419,8 @@ If successful \code{xs} invisibly, if not an error message. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-check_dt}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-check_dt}{}}} \subsection{Method \code{check_dt()}}{ \pkg{checkmate}-like check-function. Takes a \link[data.table:data.table]{data.table::data.table} where rows are points and columns are parameters. A point x is feasible, @@ -416,8 +443,8 @@ If successful \code{TRUE}, if not a string with the error message. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-test_dt}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-test_dt}{}}} \subsection{Method \code{test_dt()}}{ \pkg{checkmate}-like test-function (s. \verb{$check_dt()}). \subsection{Usage}{ @@ -436,8 +463,8 @@ If successful \code{TRUE}, if not \code{FALSE}. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-assert_dt}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-assert_dt}{}}} \subsection{Method \code{assert_dt()}}{ \pkg{checkmate}-like assert-function (s. \verb{$check_dt()}). \subsection{Usage}{ @@ -460,8 +487,8 @@ If successful \code{xs} invisibly, if not an error message. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-add_dep}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-add_dep}{}}} \subsection{Method \code{add_dep()}}{ Adds a dependency to this set, so that param \code{id} now depends on param \code{on}. \subsection{Usage}{ @@ -481,8 +508,8 @@ Adds a dependency to this set, so that param \code{id} now depends on param \cod } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-format}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-format}{}}} \subsection{Method \code{format()}}{ Helper for print outputs. \subsection{Usage}{ @@ -491,8 +518,8 @@ Helper for print outputs. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-print}{}}} \subsection{Method \code{print()}}{ Printer. \subsection{Usage}{ @@ -515,8 +542,8 @@ Which fields should not be printed? Default is \code{"levels"}, } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSet-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamSetCollection.Rd b/man/ParamSetCollection.Rd index 0ec29b62..3cd31a8a 100644 --- a/man/ParamSetCollection.Rd +++ b/man/ParamSetCollection.Rd @@ -60,34 +60,35 @@ When you set values, all previously set values will be unset / removed.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamSetCollection$new()}} -\item \href{#method-add}{\code{ParamSetCollection$add()}} -\item \href{#method-remove_sets}{\code{ParamSetCollection$remove_sets()}} -\item \href{#method-subset}{\code{ParamSetCollection$subset()}} -\item \href{#method-clone}{\code{ParamSetCollection$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/ParamSet.html#method-add_dep}{\code{paradox::ParamSet$add_dep()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-assert}{\code{paradox::ParamSet$assert()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-assert_dt}{\code{paradox::ParamSet$assert_dt()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-check}{\code{paradox::ParamSet$check()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-check_dt}{\code{paradox::ParamSet$check_dt()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-format}{\code{paradox::ParamSet$format()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-get_values}{\code{paradox::ParamSet$get_values()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-ids}{\code{paradox::ParamSet$ids()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-print}{\code{paradox::ParamSet$print()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-search_space}{\code{paradox::ParamSet$search_space()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-test}{\code{paradox::ParamSet$test()}}\out{} -\item \out{}\href{../../paradox/html/ParamSet.html#method-test_dt}{\code{paradox::ParamSet$test_dt()}}\out{} -} -\out{
} -} +\item \href{#method-ParamSetCollection-new}{\code{ParamSetCollection$new()}} +\item \href{#method-ParamSetCollection-add}{\code{ParamSetCollection$add()}} +\item \href{#method-ParamSetCollection-remove_sets}{\code{ParamSetCollection$remove_sets()}} +\item \href{#method-ParamSetCollection-subset}{\code{ParamSetCollection$subset()}} +\item \href{#method-ParamSetCollection-clone}{\code{ParamSetCollection$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSetCollection-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -104,8 +105,8 @@ Parameter objects are cloned.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-add}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSetCollection-add}{}}} \subsection{Method \code{add()}}{ Adds a set to this collection. \subsection{Usage}{ @@ -121,8 +122,8 @@ Adds a set to this collection. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-remove_sets}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSetCollection-remove_sets}{}}} \subsection{Method \code{remove_sets()}}{ Removes sets of given ids from collection. \subsection{Usage}{ @@ -138,8 +139,8 @@ Removes sets of given ids from collection. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-subset}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSetCollection-subset}{}}} \subsection{Method \code{subset()}}{ Only included for consistency. Not allowed to perform on \link{ParamSetCollection}s. \subsection{Usage}{ @@ -155,8 +156,8 @@ Only included for consistency. Not allowed to perform on \link{ParamSetCollectio } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamSetCollection-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/ParamUty.Rd b/man/ParamUty.Rd index f9fdec2b..de1adfe0 100644 --- a/man/ParamUty.Rd +++ b/man/ParamUty.Rd @@ -72,27 +72,27 @@ Always \code{"list"} for \link{ParamUty}.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{ParamUty$new()}} -\item \href{#method-clone}{\code{ParamUty$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Param.html#method-assert}{\code{paradox::Param$assert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-check}{\code{paradox::Param$check()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-convert}{\code{paradox::Param$convert()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-format}{\code{paradox::Param$format()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-print}{\code{paradox::Param$print()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-qunif}{\code{paradox::Param$qunif()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-rep}{\code{paradox::Param$rep()}}\out{} -\item \out{}\href{../../paradox/html/Param.html#method-test}{\code{paradox::Param$test()}}\out{} -} -\out{
} -} +\item \href{#method-ParamUty-new}{\code{ParamUty$new()}} +\item \href{#method-ParamUty-clone}{\code{ParamUty$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamUty-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -141,8 +141,8 @@ Custom representation string. Used for parameter table in help pages.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-ParamUty-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler.Rd b/man/Sampler.Rd index 3004597d..08b3a4ca 100644 --- a/man/Sampler.Rd +++ b/man/Sampler.Rd @@ -29,16 +29,16 @@ Domain / support of the distribution we want to sample from.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler$new()}} -\item \href{#method-sample}{\code{Sampler$sample()}} -\item \href{#method-format}{\code{Sampler$format()}} -\item \href{#method-print}{\code{Sampler$print()}} -\item \href{#method-clone}{\code{Sampler$clone()}} +\item \href{#method-Sampler-new}{\code{Sampler$new()}} +\item \href{#method-Sampler-sample}{\code{Sampler$sample()}} +\item \href{#method-Sampler-format}{\code{Sampler$format()}} +\item \href{#method-Sampler-print}{\code{Sampler$print()}} +\item \href{#method-Sampler-clone}{\code{Sampler$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. @@ -59,8 +59,8 @@ ParamSet is cloned on construction.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-sample}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler-sample}{}}} \subsection{Method \code{sample()}}{ Sample \code{n} values from the distribution. \subsection{Usage}{ @@ -79,8 +79,8 @@ Sample \code{n} values from the distribution. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-format}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler-format}{}}} \subsection{Method \code{format()}}{ Helper for print outputs. \subsection{Usage}{ @@ -89,8 +89,8 @@ Helper for print outputs. } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler-print}{}}} \subsection{Method \code{print()}}{ Printer. \subsection{Usage}{ @@ -106,8 +106,8 @@ Printer. } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler1D.Rd b/man/Sampler1D.Rd index a96a10f3..12cf81b3 100644 --- a/man/Sampler1D.Rd +++ b/man/Sampler1D.Rd @@ -33,22 +33,22 @@ Returns the one Parameter that is sampled from.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler1D$new()}} -\item \href{#method-clone}{\code{Sampler1D$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-Sampler1D-new}{\code{Sampler1D$new()}} +\item \href{#method-Sampler1D-clone}{\code{Sampler1D$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1D-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. @@ -68,8 +68,8 @@ Domain / support of the distribution we want to sample from.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1D-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler1DCateg.Rd b/man/Sampler1DCateg.Rd index b2fa7d56..e8f1b966 100644 --- a/man/Sampler1DCateg.Rd +++ b/man/Sampler1DCateg.Rd @@ -32,22 +32,22 @@ Numeric vector of \code{param$nlevels} probabilities.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler1DCateg$new()}} -\item \href{#method-clone}{\code{Sampler1DCateg$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-Sampler1DCateg-new}{\code{Sampler1DCateg$new()}} +\item \href{#method-Sampler1DCateg-clone}{\code{Sampler1DCateg$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DCateg-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -67,8 +67,8 @@ Numeric vector of \code{param$nlevels} probabilities, which is uniform by defaul } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DCateg-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler1DNormal.Rd b/man/Sampler1DNormal.Rd index 6e5bc89b..e4e7cfa6 100644 --- a/man/Sampler1DNormal.Rd +++ b/man/Sampler1DNormal.Rd @@ -35,22 +35,22 @@ SD parameter of the normal distribution.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler1DNormal$new()}} -\item \href{#method-clone}{\code{Sampler1DNormal$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-Sampler1DNormal-new}{\code{Sampler1DNormal$new()}} +\item \href{#method-Sampler1DNormal-clone}{\code{Sampler1DNormal$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DNormal-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -75,8 +75,8 @@ Default is \code{(param$upper - param$lower)/4}.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DNormal-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler1DRfun.Rd b/man/Sampler1DRfun.Rd index bc1ae8cb..22f6a87f 100644 --- a/man/Sampler1DRfun.Rd +++ b/man/Sampler1DRfun.Rd @@ -35,22 +35,22 @@ Random number generator function.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler1DRfun$new()}} -\item \href{#method-clone}{\code{Sampler1DRfun$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-Sampler1DRfun-new}{\code{Sampler1DRfun$new()}} +\item \href{#method-Sampler1DRfun-clone}{\code{Sampler1DRfun$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DRfun-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -73,8 +73,8 @@ Random number generator function, e.g. \code{rexp} to sample from exponential di } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DRfun-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/Sampler1DUnif.Rd b/man/Sampler1DUnif.Rd index a3c6fb02..09cf10f0 100644 --- a/man/Sampler1DUnif.Rd +++ b/man/Sampler1DUnif.Rd @@ -24,22 +24,22 @@ Other Sampler: \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Sampler1DUnif$new()}} -\item \href{#method-clone}{\code{Sampler1DUnif$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-Sampler1DUnif-new}{\code{Sampler1DUnif$new()}} +\item \href{#method-Sampler1DUnif-clone}{\code{Sampler1DUnif$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DUnif-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -56,8 +56,8 @@ Domain / support of the distribution we want to sample from.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Sampler1DUnif-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/SamplerHierarchical.Rd b/man/SamplerHierarchical.Rd index 429feb5a..6f221be7 100644 --- a/man/SamplerHierarchical.Rd +++ b/man/SamplerHierarchical.Rd @@ -34,22 +34,22 @@ List of \link{Sampler1D} objects that gives a Sampler for each \link{Param} in t \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{SamplerHierarchical$new()}} -\item \href{#method-clone}{\code{SamplerHierarchical$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-SamplerHierarchical-new}{\code{SamplerHierarchical$new()}} +\item \href{#method-SamplerHierarchical-clone}{\code{SamplerHierarchical$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerHierarchical-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -70,8 +70,8 @@ List of \link{Sampler1D} objects that gives a Sampler for each \link{Param} in t } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerHierarchical-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/SamplerJointIndep.Rd b/man/SamplerJointIndep.Rd index db5bc8b1..25477667 100644 --- a/man/SamplerJointIndep.Rd +++ b/man/SamplerJointIndep.Rd @@ -32,22 +32,22 @@ List of \link{Sampler} objects.} \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{SamplerJointIndep$new()}} -\item \href{#method-clone}{\code{SamplerJointIndep$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-SamplerJointIndep-new}{\code{SamplerJointIndep$new()}} +\item \href{#method-SamplerJointIndep-clone}{\code{SamplerJointIndep$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerJointIndep-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -64,8 +64,8 @@ List of \link{Sampler} objects.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerJointIndep-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/SamplerUnif.Rd b/man/SamplerUnif.Rd index c6309a7a..a405c822 100644 --- a/man/SamplerUnif.Rd +++ b/man/SamplerUnif.Rd @@ -26,22 +26,22 @@ Other Sampler: \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{SamplerUnif$new()}} -\item \href{#method-clone}{\code{SamplerUnif$clone()}} -} -} -\if{html}{ -\out{
Inherited methods} -\itemize{ -\item \out{}\href{../../paradox/html/Sampler.html#method-format}{\code{paradox::Sampler$format()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-print}{\code{paradox::Sampler$print()}}\out{} -\item \out{}\href{../../paradox/html/Sampler.html#method-sample}{\code{paradox::Sampler$sample()}}\out{} -} -\out{
} -} +\item \href{#method-SamplerUnif-new}{\code{SamplerUnif$new()}} +\item \href{#method-SamplerUnif-clone}{\code{SamplerUnif$clone()}} +} +} +\if{html}{\out{ +
Inherited methods + +
+}} \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerUnif-new}{}}} \subsection{Method \code{new()}}{ Creates a new instance of this \link[R6:R6Class]{R6} class. \subsection{Usage}{ @@ -59,8 +59,8 @@ ParamSet is cloned on construction.} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-SamplerUnif-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{