BranchBreakingOptions: Set options for branch breaking
In paravian/nitro: Integration of TNT in R
BranchBreakingOptions R Documentation
Set options for branch breaking
Description
BranchBreakingOptions is an R6 class that defines the set of optiopns
required to perform branch breaking.
Active bindings
swapperA character vector indicating the branch swapping algorithm
to use. Options are either 'tbr' (the default) or 'spr'.
cluster_sizeAn integer value indicating the number of nodes
(clusters) to use during swapping. Applied only when swapper is
set to tbr. Larger clusters will result in faster swapping as
matrix size increases. If left as 0 (the default), cluster size will be
automatically determined.
safe_unclipA logical value indicating whether to use a safer but
slower method for updating buffers when clipping to find a better tree.
Applied only when swapper is set to tbr.
fill_onlyA logical value indicating whether to stop swapping when
the tree buffer is full.
save_multipleA logical value indicating whether to save multiple
trees during swapping.
random_clipA logical value indicating whether to randomize the
tree clipping sequence.
Methods
Public methods
-
-
-
-
Method new()
Usage
BranchBreakingOptions$new(
swapper = "tbr",
cluster_size = 0,
safe_unclip = FALSE,
fill_only = FALSE,
save_multiple = TRUE,
random_clip = FALSE
)
Arguments
swapperA character vector indicating the branch swapping algorithm
to use. Options are either 'tbr' (the default) or 'spr'.
cluster_sizeAn integer value indicating the number of nodes
(clusters) to use during swapping. Applied only when swapper is
set to tbr. Larger clusters will result in faster swapping as
matrix size increases. If left as 0 (the default), cluster size will be
automatically determined.
safe_unclipA logical value indicating whether to use a safer but
slower method for updating buffers when clipping to find a better tree.
Applied only when swapper is set to tbr.
fill_onlyA logical value indicating whether to stop swapping when
the tree buffer is full.
save_multipleA logical value indicating whether to save multiple
trees during swapping.
random_clipA logical value indicating whether to randomize the
tree clipping sequence.
Method print()
Usage
BranchBreakingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
BranchBreakingOptions$queue(...)
Arguments
...Ignored.
Method clone()
The objects of this class are cloneable with this method.
Usage
BranchBreakingOptions$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
paravian/nitro documentation built on Jan. 17, 2025, 11:21 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| BranchBreakingOptions | R Documentation |
Set options for branch breaking
Description
BranchBreakingOptions is an R6 class that defines the set of optiopns
required to perform branch breaking.
Active bindings
swapperA character vector indicating the branch swapping algorithm to use. Options are either '
tbr' (the default) or 'spr'.cluster_sizeAn integer value indicating the number of nodes (clusters) to use during swapping. Applied only when
swapperis set totbr. Larger clusters will result in faster swapping as matrix size increases. If left as 0 (the default), cluster size will be automatically determined.safe_unclipA logical value indicating whether to use a safer but slower method for updating buffers when clipping to find a better tree. Applied only when
swapperis set totbr.fill_onlyA logical value indicating whether to stop swapping when the tree buffer is full.
save_multipleA logical value indicating whether to save multiple trees during swapping.
random_clipA logical value indicating whether to randomize the tree clipping sequence.
Methods
Public methods
Method new()
Usage
BranchBreakingOptions$new( swapper = "tbr", cluster_size = 0, safe_unclip = FALSE, fill_only = FALSE, save_multiple = TRUE, random_clip = FALSE )
Arguments
swapperA character vector indicating the branch swapping algorithm to use. Options are either '
tbr' (the default) or 'spr'.cluster_sizeAn integer value indicating the number of nodes (clusters) to use during swapping. Applied only when
swapperis set totbr. Larger clusters will result in faster swapping as matrix size increases. If left as 0 (the default), cluster size will be automatically determined.safe_unclipA logical value indicating whether to use a safer but slower method for updating buffers when clipping to find a better tree. Applied only when
swapperis set totbr.fill_onlyA logical value indicating whether to stop swapping when the tree buffer is full.
save_multipleA logical value indicating whether to save multiple trees during swapping.
random_clipA logical value indicating whether to randomize the tree clipping sequence.
Method print()
Usage
BranchBreakingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
BranchBreakingOptions$queue(...)
Arguments
...Ignored.
Method clone()
The objects of this class are cloneable with this method.
Usage
BranchBreakingOptions$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.