add global object set limits policies

Author: nicolaspayette

POSEIDON/src/main/java/uk/ac/ox/oxfish/regulations/quantities/YearlyCounter.java

@@ -14,6 +14,10 @@ public class YearlyCounter implements AlgorithmFactory<Quantity> {
     public YearlyCounter() {
     }
 
+    public YearlyCounter(final String name) {
+        this.name = new StringParameter(name);
+    }
+
     public YearlyCounter(final StringParameter name) {
         this.name = name;
     }

POSEIDON/src/main/java/uk/ac/ox/oxfish/regulations/quantities/YearlyGatherer.java

@@ -14,6 +14,10 @@ public class YearlyGatherer implements AlgorithmFactory<Quantity> {
     public YearlyGatherer() {
     }
 
+    public YearlyGatherer(final String name) {
+        this.name = new StringParameter(name);
+    }
+
     public YearlyGatherer(final StringParameter name) {
         this.name = name;
     }

epo/src/main/java/uk/ac/ox/poseidon/epo/ActiveFadLimitsPolicies.java

@@ -8,20 +8,19 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
-import java.util.function.Supplier;
 
 import static com.google.common.collect.ImmutableList.toImmutableList;
 import static com.google.common.collect.ImmutableMap.toImmutableMap;
 import static uk.ac.ox.oxfish.fisher.purseseiner.DefaultEpoRegulations.ACTIVE_FAD_LIMITS;
 import static uk.ac.ox.oxfish.fisher.purseseiner.DefaultEpoRegulations.makeActiveFadLimits;
 
-public class ActiveFadLimitsPolicies implements Supplier<List<Policy<EpoScenario<?>>>> {
+public class ActiveFadLimitsPolicies implements PolicySupplier {
 
     private final int referenceYear;
     private final int yearToModify;
     private final List<Double> proportionsOfCurrentLimits;
 
-    public ActiveFadLimitsPolicies(
+    ActiveFadLimitsPolicies(
         final int referenceYear,
         final int yearToModify,
         final List<Double> proportionsOfCurrentLimits

epo/src/main/java/uk/ac/ox/poseidon/epo/GlobalObjectSetLimit.java

@@ -0,0 +1,53 @@
+package uk.ac.ox.poseidon.epo;
+
+import uk.ac.ox.oxfish.experiments.tuna.Policy;
+import uk.ac.ox.oxfish.model.scenario.EpoScenario;
+import uk.ac.ox.oxfish.regulations.ForbiddenIf;
+import uk.ac.ox.oxfish.regulations.NamedRegulations;
+import uk.ac.ox.oxfish.regulations.conditions.ActionCodeIs;
+import uk.ac.ox.oxfish.regulations.conditions.AllOf;
+import uk.ac.ox.oxfish.regulations.conditions.AnyOf;
+import uk.ac.ox.oxfish.regulations.conditions.NotBelow;
+import uk.ac.ox.oxfish.regulations.quantities.YearlyGatherer;
+
+import java.util.List;
+
+import static com.google.common.collect.ImmutableList.toImmutableList;
+
+public class GlobalObjectSetLimit implements PolicySupplier {
+
+    private final List<Integer> limits;
+
+    public GlobalObjectSetLimit(final List<Integer> limits) {
+        this.limits = limits;
+    }
+
+    @Override
+    public List<Policy<EpoScenario<?>>> get() {
+        return limits
+            .stream()
+            .map(limit ->
+                new Policy<EpoScenario<?>>(
+                    "Global limit of %d object sets",
+                    scenario ->
+                        ((NamedRegulations) scenario.getRegulations())
+                            .modify(
+                                "Global object-set limits",
+                                ignored -> new ForbiddenIf(
+                                    new AllOf(
+                                        new AnyOf(
+                                            new ActionCodeIs("FAD"),
+                                            new ActionCodeIs("OFS")
+                                        ),
+                                        new NotBelow(
+                                            new YearlyGatherer("Number of FAD sets"),
+                                            limit
+                                        )
+                                    )
+                                )
+                            )
+                )
+            )
+            .collect(toImmutableList());
+    }
+}

epo/src/main/java/uk/ac/ox/poseidon/epo/PolicyRuns.java

@@ -11,6 +11,8 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+import static java.util.stream.Collectors.toList;
+
 public class PolicyRuns {
 
     public static void main(final String[] args) {
@@ -21,11 +23,16 @@ public static void main(final String[] args) {
             "calibrated_scenario.yaml"
         ));
         final Path baseOutputFolder = baseFolder.resolve(Paths.get("policy_runs"));
+        final ImmutableList<Double> proportions = ImmutableList.of(1.0, 0.75, 0.50, 0.25, 0.10, 0.0);
         ImmutableMap.of(
+                "global_object_set_limits", new GlobalObjectSetLimit(
+                    // 8729 FAD + 4003 OFS in 2022
+                    proportions.stream().map(p -> (int) (p * (8729 + 4003))).collect(toList())
+                ),
                 "fad_limits", new ActiveFadLimitsPolicies(
                     2022,
                     2023,
-                    ImmutableList.of(1.0, 0.75, 0.50, 0.25, 0.10, 0.0)
+                    proportions
                 )
             )
             .entrySet()

epo/src/main/java/uk/ac/ox/poseidon/epo/PolicySupplier.java

@@ -0,0 +1,10 @@
+package uk.ac.ox.poseidon.epo;
+
+import uk.ac.ox.oxfish.experiments.tuna.Policy;
+import uk.ac.ox.oxfish.model.scenario.EpoScenario;
+
+import java.util.List;
+import java.util.function.Supplier;
+
+public interface PolicySupplier extends Supplier<List<Policy<EpoScenario<?>>>> {
+}