diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-05-04 19:19:47 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-05-05 10:03:15 +0200 |
| commit | 4a8b32d288ba3ee986ecef7933fa77554d34e762 (patch) | |
| tree | 97b9be67e51c82b9c959efc5e464aaa8c53a57bf /opendc-harness/src/main/kotlin/org/opendc/harness/api | |
| parent | e021d46ab1601d0c3a00724358164483608f6297 (diff) | |
harness: Split harness into separate modules
This change splits the OpenDC Experiment Harness into separate modules.
This prevents users from pulling in unnecessary dependencies when
depending on the harness API.
Diffstat (limited to 'opendc-harness/src/main/kotlin/org/opendc/harness/api')
4 files changed, 0 insertions, 151 deletions
diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/api/ExperimentDefinition.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/api/ExperimentDefinition.kt deleted file mode 100644 index 88b26ee1..00000000 --- a/opendc-harness/src/main/kotlin/org/opendc/harness/api/ExperimentDefinition.kt +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Copyright (c) 2020 AtLarge Research - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ - -package org.opendc.harness.api - -/** - * A definition for a repeatable experiment which consists of multiple scenarios derived from pre-defined experiment - * parameters. - * - * @property name The name of the experiment. - * @property parameters The parameters of the experiments. - * @property evaluator The function to evaluate a single experiment trial. - * @property meta The metadata for the experiment. - */ -public data class ExperimentDefinition( - val name: String, - val parameters: Set<Parameter<*>>, - val evaluator: (Trial) -> Unit, - val meta: Map<String, Any> = emptyMap() -) diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Parameter.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/api/Parameter.kt deleted file mode 100644 index bb5c8c2b..00000000 --- a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Parameter.kt +++ /dev/null @@ -1,38 +0,0 @@ -/* - * Copyright (c) 2020 AtLarge Research - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ - -package org.opendc.harness.api - -/** - * A [Parameter] defines a single dimension of exploration in the design space of an experiment. - */ -public sealed class Parameter<T> { - /** - * The name of the parameter. - */ - public abstract val name: String - - /** - * A generic dimension of the experiment design space that is defined fully by a collection of [values]. - */ - public data class Generic<T>(override val name: String, val values: Collection<T>) : Parameter<T>() -} diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt deleted file mode 100644 index a8dbf01e..00000000 --- a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Scenario.kt +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright (c) 2021 AtLarge Research - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ - -package org.opendc.harness.api - -/** - * A [Scenario] represents a single point in the design space of an experiment. - */ -public interface Scenario { - /** - * A unique identifier that identifies a single scenario. - */ - public val id: Int - - /** - * The [ExperimentDefinition] describing the experiment this scenario is part of. - */ - public val experiment: ExperimentDefinition - - /** - * Obtain the instantiated value for a [parameter][param] of the experiment. - * - * @param param The parameter to obtain the value of. - * @throws IllegalArgumentException if [param] is not defined for the experiment. - */ - public operator fun <T> get(param: Parameter<T>): T -} diff --git a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Trial.kt b/opendc-harness/src/main/kotlin/org/opendc/harness/api/Trial.kt deleted file mode 100644 index 2d6ecd19..00000000 --- a/opendc-harness/src/main/kotlin/org/opendc/harness/api/Trial.kt +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright (c) 2021 AtLarge Research - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ - -package org.opendc.harness.api - -/** - * A [Trial] represents a single trial (run) of an experiment. - */ -public data class Trial(val scenario: Scenario, val repeat: Int) |
