Skip to content

Commit ee1cd1e

Browse files
committed
Reorganized BlackBox
1 parent c1c4505 commit ee1cd1e

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

src/BlackBox.jl

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ module BlackBox
66
export
77
Simulation,
88
initialize!,
9+
evaluate!,
10+
transition_model!,
911
isevent!,
1012
miss_distance!,
11-
transition_model!,
12-
evaluate!,
1313
isterminal!
1414

1515

@@ -30,35 +30,35 @@ function initialize! end
3030

3131

3232
"""
33-
isevent!(sim::BlackBox.Simulation)::Bool
33+
evaluate!(sim::BlackBox.Simulation)::Tuple(transition_probability, isevent, miss_distance)
3434
35-
Return a boolean indicating if the SUT reached an event of interest.
35+
Evaluate the SUT given some input seed and current state, returns `transition_probability`, `isevent` indication, and `miss_distance`.
3636
"""
37-
function isevent! end
37+
function evaluate! end
3838

3939

4040
"""
41-
miss_distance!(sim::BlackBox.Simulation)
41+
transition_model!(sim::BlackBox.Simulation)::Tuple(logprob, sample)
4242
43-
Return how close to an event a terminal state was (i.e. some measure of "miss distance" to the event of interest).
43+
Return the transition probability and sampled value given the current state [0-1].
4444
"""
45-
function miss_distance! end
45+
function transition_model! end
4646

4747

4848
"""
49-
transition_model!(sim::BlackBox.Simulation)::Tuple(logprob, sample)
49+
isevent!(sim::BlackBox.Simulation)::Bool
5050
51-
Return the transition probability and sampled value given the current state [0-1].
51+
Return a boolean indicating if the SUT reached an event of interest.
5252
"""
53-
function transition_model! end
53+
function isevent! end
5454

5555

5656
"""
57-
evaluate!(sim::BlackBox.Simulation)::Tuple(transition_probability, isevent, miss_distance)
57+
miss_distance!(sim::BlackBox.Simulation)
5858
59-
Evaluate the SUT given some input seed and current state, returns `transition_probability`, `isevent` indication, and `miss_distance`.
59+
Return how close to an event a terminal state was (i.e. some measure of "miss distance" to the event of interest).
6060
"""
61-
function evaluate! end
61+
function miss_distance! end
6262

6363

6464
"""

0 commit comments

Comments
 (0)