Skip to content

Commit 529eb47

Browse files
damar-wicaksonodamar-wicaksono
authored
Merge pull request #367 from damar-wicaksono/dev-350
Rename `spatial_dimension` to `input_dimension`
2 parents bd1e85a + 836c598 commit 529eb47

File tree

102 files changed

+723
-705
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+723
-705
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2323

2424
### Changed
2525

26+
- The property `spatial_dimension` of `ProbInput` and `UQTestFunBareABC` is
27+
renamed to `input_dimension` for clarity (as opposed to `output_dimension`).
2628
- The property `name` of UQ test function instances has been renamed to
2729
`function_id` that implies uniqueness although it is not strictly enforced.
2830
- The parameter in the Gramacy 1D sine function is now removed. Noise can

‎docs/development/adding-test-function-implementation.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ A concrete implementation of this base class requires the following:
290290

291291
- a static method named `evaluate()`
292292
- several class-level properties, namely: `_tags`, `_description`,
293-
`_available_inputs`, `_available_parameters`, `_default_spatial_dimension`,
293+
`_available_inputs`, `_available_parameters`, `_default_input_dimension`,
294294
`_default_input`, and `_default_parameters`.
295295

296296
The full definition of the class for the Branin test function is shown below.
@@ -303,7 +303,7 @@ class Branin(UQTestFunABC):
303303
_description = "Branin function from Dixon and Szegö (1978)" # Short description
304304
_available_inputs = AVAILABLE_INPUT_SPECS # As defined above
305305
_available_parameters = AVAILABLE_PARAMETERS # As defined above
306-
_default_spatial_dimension = 2 # Spatial dimension of the function
306+
_default_input_dimension = 2 # input dimension of the function
307307
_default_input = "Dixon1978" # Optional, if only one input is available
308308
_default_parameters = "Dixon1978" # Optional, if only one set of parameters is available
309309

@@ -346,11 +346,13 @@ built-in functions from a Python terminal.
346346
```python
347347
>>> import uqtestfuns as uqtf
348348
>>> uqtf.list_functions()
349-
No. Constructor Spatial Dimension Application Description
350-
----- ------------------ ------------------- -------------------------- ----------------------------------------------------------------------------
351-
1 Ackley() M optimization, metamodeling Ackley function from Ackley (1987)
352-
2 Borehole() 8 metamodeling, sensitivity Borehole function from Harper and Gupta (1983)
353-
3 Branin() 2 optimization Branin function from Dixon and Szegö (1978)
349+
No. Constructor Input Dim. Parameterized Application Description
350+
----- ----------------------------- ------------ --------------- -------------------------------------- ----------------------------------------------------------------------------
351+
1 Ackley() M True optimization, metamodeling Optimization test function from Ackley (1987)
352+
2 Alemazkoor20D() 20 False metamodeling High-dimensional low-degree polynomial from Alemazkoor & Meidani (2018)
353+
3 Alemazkoor2D() 2 False metamodeling Low-dimensional high-degree polynomial from Alemazkoor & Meidani (2018)
354+
4 Borehole() 8 False metamodeling, sensitivity Borehole function from Harper and Gupta (1983)
355+
5 Branin() 2 True optimization Branin function from Dixon and Szegö (1978)
354356
...
355357
```
356358

‎docs/fundamentals/integration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ kernelspec:
1717
The table below listed the available test functions typically used
1818
in the testing and comparison of numerical integration method.
1919

20-
| Name | Spatial Dimension | Constructor |
21-
|:------------------------------------------------------------:|:-----------------:|:-------------------:|
22-
| {ref}`Bratley et al. (1992) A <test-functions:bratley1992a>` | M | `Bratley1992a()` |
23-
| {ref}`Bratley et al. (1992) B <test-functions:bratley1992b>` | M | `Bratley1992b()` |
24-
| {ref}`Bratley et al. (1992) C <test-functions:bratley1992c>` | M | `Bratley1992c()` |
25-
| {ref}`Bratley et al. (1992) D <test-functions:bratley1992d>` | M | `Bratley1992d()` |
26-
| {ref}`Sobol'-G <test-functions:sobol-g>` | M | `SobolG()` |
27-
| {ref}`Welch et al. (1992) <test-functions:welch1992>` | 20 | `Welch1992()` |
20+
| Name | Input Dimension | Constructor |
21+
|:------------------------------------------------------------:|:---------------:|:-------------------:|
22+
| {ref}`Bratley et al. (1992) A <test-functions:bratley1992a>` | M | `Bratley1992a()` |
23+
| {ref}`Bratley et al. (1992) B <test-functions:bratley1992b>` | M | `Bratley1992b()` |
24+
| {ref}`Bratley et al. (1992) C <test-functions:bratley1992c>` | M | `Bratley1992c()` |
25+
| {ref}`Bratley et al. (1992) D <test-functions:bratley1992d>` | M | `Bratley1992d()` |
26+
| {ref}`Sobol'-G <test-functions:sobol-g>` | M | `SobolG()` |
27+
| {ref}`Welch et al. (1992) <test-functions:welch1992>` | 20 | `Welch1992()` |
2828

2929
In a Python terminal, you can list all the available functions relevant
3030
for metamodeling applications using ``list_functions()`` and filter the results

‎docs/fundamentals/metamodeling.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,37 @@ kernelspec:
1717
The table below listed the available test functions typically used
1818
in the comparison of metamodeling approaches.
1919

20-
| Name | Spatial Dimension | Constructor |
21-
|:----------------------------------------------------------------------:|:-----------------:|:--------------------:|
22-
| {ref}`Ackley <test-functions:ackley>` | M | `Ackley()` |
23-
| {ref}`Alemazkoor & Meidani (2018) 2D <test-functions:alemazkoor-2d>` | 2 | `Alemazkoor2D()` |
24-
| {ref}`Alemazkoor & Meidani (2018) 20D <test-functions:alemazkoor-20d>` | 20 | `Alemazkoor20D()` |
25-
| {ref}`Borehole <test-functions:borehole>` | 8 | `Borehole()` |
26-
| {ref}`Damped Cosine <test-functions:damped-cosine>` | 1 | `DampedCosine()` |
27-
| {ref}`Damped Oscillator <test-functions:damped-oscillator>` | 7 | `DampedOscillator()` |
28-
| {ref}`Flood <test-functions:flood>` | 8 | `Flood()` |
29-
| {ref}`Forrester et al. (2008) <test-functions:forrester>` | 1 | `Forrester2008()` |
30-
| {ref}`(1st) Franke <test-functions:franke-1>` | 2 | `Franke1()` |
31-
| {ref}`(2nd) Franke <test-functions:franke-2>` | 2 | `Franke2()` |
32-
| {ref}`(3rd) Franke <test-functions:franke-3>` | 2 | `Franke3()` |
33-
| {ref}`(4th) Franke <test-functions:franke-4>` | 2 | `Franke4()` |
34-
| {ref}`(5th) Franke <test-functions:franke-5>` | 2 | `Franke5()` |
35-
| {ref}`(6th) Franke <test-functions:franke-6>` | 2 | `Franke6()` |
36-
| {ref}`Friedman (6D) <test-functions:friedman-6d>` | 6 | `Friedman6D()` |
37-
| {ref}`Friedman (10D) <test-functions:friedman-10d>` | 10 | `Friedman10D()` |
38-
| {ref}`Gramacy (2007) 1D Sine <test-functions:gramacy-1d-sine>` | 1 | `Gramacy1DSine()` |
39-
| {ref}`McLain S1 <test-functions:mclain-s1>` | 2 | `McLainS1()` |
40-
| {ref}`McLain S2 <test-functions:mclain-s2>` | 2 | `McLainS2()` |
41-
| {ref}`McLain S3 <test-functions:mclain-s3>` | 2 | `McLainS3()` |
42-
| {ref}`McLain S4 <test-functions:mclain-s4>` | 2 | `McLainS4()` |
43-
| {ref}`McLain S5 <test-functions:mclain-s5>` | 2 | `McLainS5()` |
44-
| {ref}`Oakley & O'Hagan (2002) 1D <test-functions:oakley-1d>` | 1 | `Oakley1D()` |
45-
| {ref}`OTL Circuit <test-functions:otl-circuit>` | 6 / 20 | `OTLCircuit()` |
46-
| {ref}`Piston Simulation <test-functions:piston>` | 7 / 20 | `Piston()` |
47-
| {ref}`Webster et al. (1996) 2D <test-functions:webster-2d>` | 2 | `Webster2D()` |
48-
| {ref}`Sulfur <test-functions:sulfur>` | 9 | `Sulfur()` |
49-
| {ref}`Welch1992 <test-functions:welch1992>` | 20 | `Welch1992()` |
50-
| {ref}`Wing Weight <test-functions:wing-weight>` | 10 | `WingWeight()` |
20+
| Name | Input Dimension | Constructor |
21+
|:----------------------------------------------------------------------:|:---------------:|:--------------------:|
22+
| {ref}`Ackley <test-functions:ackley>` | M | `Ackley()` |
23+
| {ref}`Alemazkoor & Meidani (2018) 2D <test-functions:alemazkoor-2d>` | 2 | `Alemazkoor2D()` |
24+
| {ref}`Alemazkoor & Meidani (2018) 20D <test-functions:alemazkoor-20d>` | 20 | `Alemazkoor20D()` |
25+
| {ref}`Borehole <test-functions:borehole>` | 8 | `Borehole()` |
26+
| {ref}`Damped Cosine <test-functions:damped-cosine>` | 1 | `DampedCosine()` |
27+
| {ref}`Damped Oscillator <test-functions:damped-oscillator>` | 7 | `DampedOscillator()` |
28+
| {ref}`Flood <test-functions:flood>` | 8 | `Flood()` |
29+
| {ref}`Forrester et al. (2008) <test-functions:forrester>` | 1 | `Forrester2008()` |
30+
| {ref}`(1st) Franke <test-functions:franke-1>` | 2 | `Franke1()` |
31+
| {ref}`(2nd) Franke <test-functions:franke-2>` | 2 | `Franke2()` |
32+
| {ref}`(3rd) Franke <test-functions:franke-3>` | 2 | `Franke3()` |
33+
| {ref}`(4th) Franke <test-functions:franke-4>` | 2 | `Franke4()` |
34+
| {ref}`(5th) Franke <test-functions:franke-5>` | 2 | `Franke5()` |
35+
| {ref}`(6th) Franke <test-functions:franke-6>` | 2 | `Franke6()` |
36+
| {ref}`Friedman (6D) <test-functions:friedman-6d>` | 6 | `Friedman6D()` |
37+
| {ref}`Friedman (10D) <test-functions:friedman-10d>` | 10 | `Friedman10D()` |
38+
| {ref}`Gramacy (2007) 1D Sine <test-functions:gramacy-1d-sine>` | 1 | `Gramacy1DSine()` |
39+
| {ref}`McLain S1 <test-functions:mclain-s1>` | 2 | `McLainS1()` |
40+
| {ref}`McLain S2 <test-functions:mclain-s2>` | 2 | `McLainS2()` |
41+
| {ref}`McLain S3 <test-functions:mclain-s3>` | 2 | `McLainS3()` |
42+
| {ref}`McLain S4 <test-functions:mclain-s4>` | 2 | `McLainS4()` |
43+
| {ref}`McLain S5 <test-functions:mclain-s5>` | 2 | `McLainS5()` |
44+
| {ref}`Oakley & O'Hagan (2002) 1D <test-functions:oakley-1d>` | 1 | `Oakley1D()` |
45+
| {ref}`OTL Circuit <test-functions:otl-circuit>` | 6 / 20 | `OTLCircuit()` |
46+
| {ref}`Piston Simulation <test-functions:piston>` | 7 / 20 | `Piston()` |
47+
| {ref}`Webster et al. (1996) 2D <test-functions:webster-2d>` | 2 | `Webster2D()` |
48+
| {ref}`Sulfur <test-functions:sulfur>` | 9 | `Sulfur()` |
49+
| {ref}`Welch1992 <test-functions:welch1992>` | 20 | `Welch1992()` |
50+
| {ref}`Wing Weight <test-functions:wing-weight>` | 10 | `WingWeight()` |
5151

5252
In a Python terminal, you can list all the available functions relevant
5353
for metamodeling applications using ``list_functions()`` and filter the results

‎docs/fundamentals/optimization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ kernelspec:
1717
The table below listed the available test functions typically used
1818
in the comparison of global optimization methods.
1919

20-
| Name | Spatial Dimension | Constructor |
21-
|:-----------------------------------------------------------:|:-----------------:|:--------------------:|
22-
| {ref}`Ackley <test-functions:ackley>` | M | `Ackley()` |
23-
| {ref}`Forrester et al. (2008) <test-functions:forrester>` | 1 | `Forrester2008()` |
20+
| Name | Input Dimension | Constructor |
21+
|:-----------------------------------------------------------:|:---------------:|:--------------------:|
22+
| {ref}`Ackley <test-functions:ackley>` | M | `Ackley()` |
23+
| {ref}`Forrester et al. (2008) <test-functions:forrester>` | 1 | `Forrester2008()` |
2424

2525
In a Python terminal, you can list all the available functions relevant
2626
for optimization applications using ``list_functions()`` and filter the results

‎docs/fundamentals/reliability.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ kernelspec:
1717
The table below listed the available test functions typically used
1818
in the comparison of reliability analysis methods.
1919

20-
| Name | Spatial Dimension | Constructor |
21-
|:-----------------------------------------------------------------------------------:|:-----------------:|:-------------------------------:|
22-
| {ref}`Cantilever Beam (2D) <test-functions:cantilever-beam-2d>` | 2 | `CantileverBeam2D ` |
23-
| {ref}`Circular Pipe Crack <test-functions:circular-pipe-crack>` | 2 | `CircularPipeCrack()` |
24-
| {ref}`Convex Failure Domain <test-functions:convex-fail-domain>` | 2 | `ConvexFailDomain()` |
25-
| {ref}`Damped Oscillator Reliability <test-functions:damped-oscillator-reliability>` | 8 | `DampedOscillatorReliability()` |
26-
| {ref}`Four-branch <test-functions:four-branch>` | 2 | `FourBranch()` |
27-
| {ref}`Gayton Hat <test-functions:gayton-hat>` | 2 | `GaytonHat()` |
28-
| {ref}`Hyper-sphere Bound <test-functions:hyper-sphere>` | 2 | `HyperSphere()` |
29-
| {ref}`RS - Circular Bar <test-functions:rs-circular-bar>` | 2 | `RSCircularBar()` |
30-
| {ref}`RS - Quadratic <test-functions:rs-quadratic>` | 2 | `RSQuadratic()` |
31-
| {ref}`Speed Reducer Shaft <test-functions:speed-reducer-shaft>` | 5 | `SpeedReducerShaft()` |
20+
| Name | Input Dimension | Constructor |
21+
|:-----------------------------------------------------------------------------------:|:---------------:|:-------------------------------:|
22+
| {ref}`Cantilever Beam (2D) <test-functions:cantilever-beam-2d>` | 2 | `CantileverBeam2D ` |
23+
| {ref}`Circular Pipe Crack <test-functions:circular-pipe-crack>` | 2 | `CircularPipeCrack()` |
24+
| {ref}`Convex Failure Domain <test-functions:convex-fail-domain>` | 2 | `ConvexFailDomain()` |
25+
| {ref}`Damped Oscillator Reliability <test-functions:damped-oscillator-reliability>` | 8 | `DampedOscillatorReliability()` |
26+
| {ref}`Four-branch <test-functions:four-branch>` | 2 | `FourBranch()` |
27+
| {ref}`Gayton Hat <test-functions:gayton-hat>` | 2 | `GaytonHat()` |
28+
| {ref}`Hyper-sphere Bound <test-functions:hyper-sphere>` | 2 | `HyperSphere()` |
29+
| {ref}`RS - Circular Bar <test-functions:rs-circular-bar>` | 2 | `RSCircularBar()` |
30+
| {ref}`RS - Quadratic <test-functions:rs-quadratic>` | 2 | `RSQuadratic()` |
31+
| {ref}`Speed Reducer Shaft <test-functions:speed-reducer-shaft>` | 5 | `SpeedReducerShaft()` |
3232

3333
In a Python terminal, you can list all the available functions relevant
3434
for metamodeling applications using ``list_functions()`` and filter the results

0 commit comments

Comments
 (0)