StrategyManager.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * StrategyManager.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007, 2009 by the members listed in the COPYING,  *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.replanning;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.api.core.v01.population.Population;
import org.matsim.core.api.internal.MatsimManager;
import org.matsim.core.config.groups.ControllerConfigGroup;
import org.matsim.core.config.groups.ReplanningConfigGroup;
import org.matsim.core.replanning.choosers.StrategyChooser;
import org.matsim.core.replanning.selectors.PlanSelector;
import org.matsim.core.replanning.selectors.WorstPlanForRemovalSelector;

import jakarta.inject.Inject;
import jakarta.inject.Singleton;
import java.util.List;
import java.util.Map;

@Singleton
public class StrategyManager implements MatsimManager {
    // I understand the way in which this is integrated into the framwork as follows:
    // * The PlansReplanning interface is the one that is bound as ReplanningListener, and it calls StrategyManager.
    // * On the other hand, StrategyManager is also independently bound.
    // * This has the consequence that users (possibly via the config) may configure StrategyManager, but it is effectively ignored if the bound
    // implementation of ReplanningListener does not use it.
    // * This is the design that I found.  Not sure if I should change it, but I need something for Carrier and later for LSP.
    // * A possible way out would be to unbind StrategyManager (for someone who implements a ReplanningListener that does not use
    // StrategyManager).  This is not immediately possible, but the internet gives possibilities.  Could be added as a utility method, which would
    // (I think) make sense together with the MATSim overall design which overrides defaults instead of asking the user to plug everything together.

    // Not sure if that would work: There is other code that tries to obtain StrategyManager via injection, and all of this would then fail.
    // Not sure if one could unbind all of these.

    // kai, jun'22

    private static final Logger log = LogManager.getLogger(StrategyManager.class);

    private final GenericStrategyManagerImpl<Plan, Person> delegate;

    @Inject
    StrategyManager(ReplanningConfigGroup replanningConfigGroup,
                                    ControllerConfigGroup controllerConfigGroup, StrategyChooser<Plan, Person> strategyChooser,
                                    Map<ReplanningConfigGroup.StrategySettings, PlanStrategy> planStrategies ) {

        this(strategyChooser);
        setMaxPlansPerAgent(replanningConfigGroup.getMaxAgentPlanMemorySize());

        int globalInnovationDisableAfter = (int) ((controllerConfigGroup.getLastIteration() - controllerConfigGroup.getFirstIteration())
                * replanningConfigGroup.getFractionOfIterationsToDisableInnovation() + controllerConfigGroup.getFirstIteration());
        log.info("global innovation switch off after iteration: " + globalInnovationDisableAfter);

        for (Map.Entry<ReplanningConfigGroup.StrategySettings, PlanStrategy> entry : planStrategies.entrySet()) {
            PlanStrategy strategy = entry.getValue();
            ReplanningConfigGroup.StrategySettings settings = entry.getKey();
            addStrategy(strategy, settings.getSubpopulation(), settings.getWeight());

            // now check if this modules should be disabled after some iterations
            int maxIter = settings.getDisableAfter();
            if ( maxIter > globalInnovationDisableAfter || maxIter==-1 ) {
                if (!ReplanningUtils.isOnlySelector(strategy)) {
                    maxIter = globalInnovationDisableAfter ;
                }
            }

            if (maxIter >= 0) {
                if (maxIter >= controllerConfigGroup.getFirstIteration()) {
                    addChangeRequest(maxIter + 1, strategy, settings.getSubpopulation(), 0.0);
                } else {
                    /* The services starts at a later iteration than this change request is scheduled for.
                     * make the change right now.                    */
                    changeWeightOfStrategy(strategy, settings.getSubpopulation(), 0.0);
                }
            }
        }
    }

    public StrategyManager() {
        this.delegate = new GenericStrategyManagerImpl<>();
    }

    StrategyManager(StrategyChooser<Plan, Person> strategyChooser) {
        this.delegate = new GenericStrategyManagerImpl<>(strategyChooser);
    }

    public final void addStrategy( final PlanStrategy strategy, final String subpopulation, final double weight) {
        delegate.addStrategy(strategy, subpopulation, weight);
    }

    public final boolean removeStrategy( final PlanStrategy strategy, final String subpopulation) {
        return delegate.removeStrategy(strategy, subpopulation) ;
    }

    public final boolean changeWeightOfStrategy( final GenericPlanStrategy<Plan, Person> strategy, final String subpopulation, final double newWeight) {
        return delegate.changeWeightOfStrategy(strategy, subpopulation, newWeight) ;
    }

    public final void run(final Population population, final int iteration, final ReplanningContext replanningContext) {
        delegate.run( population.getPersons().values(), iteration, replanningContext );
    }

    public GenericPlanStrategy<Plan, Person> chooseStrategy(final Person person, final String subpopulation, ReplanningContext replanningContext) {
        return delegate.chooseStrategy(person, subpopulation, replanningContext );
    }

    public final void setMaxPlansPerAgent(final int maxPlansPerAgent) {
        delegate.setMaxPlansPerAgent(maxPlansPerAgent);
    }

    public final int getMaxPlansPerAgent() {
        return delegate.getMaxPlansPerAgent();
    }

    public final void addChangeRequest(
            final int iteration,
            final PlanStrategy strategy,
            final String subpopulation,
            final double newWeight) {
        delegate.addChangeRequest(iteration, strategy, subpopulation, newWeight);
    }

    @Inject
    public final void setPlanSelectorForRemoval(final PlanSelector<Plan, Person> planSelector) {
        delegate.setPlanSelectorForRemoval(planSelector);
    }

    public final List<GenericPlanStrategy<Plan, Person>> getStrategies(final String subpopulation) {
        return delegate.getStrategies(subpopulation) ;
    }

    public final List<Double> getWeights(final String subpopulation) {
        return delegate.getWeights(subpopulation);
    }
}