Interface class for parameter sample classes that allow the adaptive refinement of the sampling.
Definition at line 18 of file IRefineable.m.
|
| virtual function
cogs = | cogs () |
| | returns the center of gravity of sample cells (in case the sample can be viewed as a grid) More...
|
| |
virtual function
max_vertex = | elementwise_maximum_of_vertex_values (values) |
| | returns \(\max_{v \in V(e)} \text{val}_v\) for each sample cell \(e\) (in case the sample can be viewed as a grid with vertices as sample vectors) More...
|
| |
| virtual function
IRefineable this = | refine (elems) |
| | refines the object at the the given elements More...
|
| |
| virtual function
level = | get_refinement_levels () |
| | returns the number of refinement steps for each sample element More...
|
| |
| virtual function
skips = | skipped_refinements () |
| | determines for every sample element how often it was skipped during the last refinement steps. More...
|
| |
| function
sample = | get_sample_at_ref_level (ref_level) |
| | helper function returning the sample at a given refinement level More...
|
| |
| virtual function | init_sample (IDetailedModel dmodel) |
| | initializes the parameter sampling object More...
|
| |
| virtual function
size = | size () |
| | returns the number of parameter vectors in this sampling More...
|
| |
function
please_init = | init_required () |
| | returns a boolean indicating whether the object is fully functional, or must be initialized by a call to init_sample(). More...
|
| |
| function cogs = ParameterSampling.IRefineable.cogs |
( |
| ) |
|
|
pure virtual |
returns the center of gravity of sample cells (in case the sample can be viewed as a grid)
Usually the center of gravity of grid cells is a new sample vector in case the element is refined.
- Todo:
- Maybe this should be renamed to refinement_candidates, because otherwise it is restricted to grids.
- Return values
-
| cogs | a matrix with sample vectors as row vectors |
Implemented in ParameterSampling.Uniform.
| function max_vertex = ParameterSampling.IRefineable.elementwise_maximum_of_vertex_values |
( |
|
values | ) |
|
|
pure virtual |
returns \(\max_{v \in V(e)} \text{val}_v\) for each sample cell \(e\) (in case the sample can be viewed as a grid with vertices as sample vectors)
- Parameters
-
- Return values
-
| max_vertex | vector of maxima as described above |
Implemented in ParameterSampling.Uniform.
| function level = ParameterSampling.IRefineable.get_refinement_levels |
( |
| ) |
|
|
pure virtual |
returns the number of refinement steps for each sample element
- Return values
-
| level | a vector with number of refinement steps for each sample element |
Implemented in ParameterSampling.Uniform.
| function sample = ParameterSampling.IRefineable.get_sample_at_ref_level |
( |
|
ref_level | ) |
|
helper function returning the sample at a given refinement level
- Parameters
-
| ref_level | the refinement level |
- Return values
-
| sample | the parameter sample how it looked like before refinement step ref_level |
Definition at line 120 of file IRefineable.m.
| function IRefineable this = ParameterSampling.IRefineable.refine |
( |
|
elems | ) |
|
|
pure virtual |
refines the object at the the given elements
At each refinement, the refined elements and the previous sample is added to the cell arrays sample_history and refined_elements
- Parameters
-
| elems | A vector of element indices to be refined |
- Return values
-
Implemented in ParameterSampling.Uniform.
| function skips = ParameterSampling.IRefineable.skipped_refinements |
( |
| ) |
|
|
pure virtual |
determines for every sample element how often it was skipped during the last refinement steps.
- Return values
-
| skips | a vector of the number of skips for each sample element. |
Implemented in ParameterSampling.Uniform.
| ParameterSampling.IRefineable.refined_elements = {""} |
cell array of elements which are refined at each refinement step
Default: {""}
Definition at line 38 of file IRefineable.m.
| ParameterSampling.IRefineable.sample_history = {""} |
cell array of samples that are generated during refinement cycle
Default: {""}
Definition at line 29 of file IRefineable.m.
The documentation for this class was generated from the following file:
Public Member Functions inherited from ParameterSampling.Interface
1.8.8
