Skip to content

Commit 3f1d2b4

Browse files
angelacorteDanySK
authored andcommitted
docs: add missing documentation
1 parent 9a57f5c commit 3f1d2b4

File tree

1 file changed

+19
-1
lines changed
  • alchemist-implementationbase/src/main/kotlin/it/unibo/alchemist/model/terminators

1 file changed

+19
-1
lines changed

alchemist-implementationbase/src/main/kotlin/it/unibo/alchemist/model/terminators/StableMetrics.kt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,28 @@ class StableMetrics<T>(
142142
}
143143
}
144144

145+
/**
146+
* Companion object for StableMetrics.
147+
*
148+
* Provides constants relevant to the stability checks, such as maximum
149+
* and default values for steps and time.
150+
*/
145151
companion object {
152+
/**
153+
* The maximum value for steps, used to determine when the step stability is reached.
154+
*/
146155
const val STEP_MAX_VALUE: Long = MAX_VALUE
156+
/**
157+
* The default value for steps, used when no stability is required.
158+
*/
147159
const val DEFAULT_STEP: Long = 0L
148-
val DEFAULT_TIME: Time = ZERO
160+
/**
161+
* The maximum value for time, used to determine when the time stability is reached.
162+
*/
149163
val TIME_MAX_VALUE: Time = INFINITY
164+
/**
165+
* The default time value, used when no stability is required.
166+
*/
167+
val DEFAULT_TIME: Time = ZERO
150168
}
151169
}

0 commit comments

Comments
 (0)