SubtourModeChoice.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * SubtourModeChoice.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 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.modules;

import org.matsim.core.config.groups.GlobalConfigGroup;
import org.matsim.core.config.groups.SubtourModeChoiceConfigGroup;
import org.matsim.core.gbl.MatsimRandom;
import org.matsim.core.population.algorithms.ChooseRandomLegModeForSubtour;
import org.matsim.core.population.algorithms.PermissibleModesCalculator;
import org.matsim.core.population.algorithms.PlanAlgorithm;
import org.matsim.core.router.TripStructureUtils;

public class SubtourModeChoice extends AbstractMultithreadedModule {

    private final double probaForChangeSingleTripMode;
    private final double coordDist;

    public enum Behavior {
        @Deprecated
        fromAllModesToSpecifiedModes,

        fromSpecifiedModesToSpecifiedModes,

        betweenAllAndFewerConstraints
    }

    private Behavior behavior = Behavior.fromSpecifiedModesToSpecifiedModes;

    private final PermissibleModesCalculator permissibleModesCalculator;

    private final String[] chainBasedModes;
    private final String[] modes;

    public SubtourModeChoice(GlobalConfigGroup globalConfigGroup,
            SubtourModeChoiceConfigGroup subtourModeChoiceConfigGroup, PermissibleModesCalculator permissibleModesCalculator) {
        this(globalConfigGroup.getNumberOfThreads(),
                subtourModeChoiceConfigGroup.getModes(),
                subtourModeChoiceConfigGroup.getChainBasedModes(),
                subtourModeChoiceConfigGroup.getProbaForRandomSingleTripMode(),
                permissibleModesCalculator, subtourModeChoiceConfigGroup.getCoordDistance()
        );
        this.setBehavior(subtourModeChoiceConfigGroup.getBehavior());
    }

    SubtourModeChoice(
            final int numberOfThreads,
            final String[] modes,
            final String[] chainBasedModes,
            double probaForChangeSingleTripMode,
            PermissibleModesCalculator permissibleModesCalculator,
            double coordDist) {
        super(numberOfThreads);
        this.modes = modes.clone();
        this.chainBasedModes = chainBasedModes.clone();
        this.permissibleModesCalculator = permissibleModesCalculator;
        this.probaForChangeSingleTripMode = probaForChangeSingleTripMode;
        this.coordDist = coordDist;
    }

    @Deprecated // only use when backwards compatibility is needed. kai, may'18
    public final void setBehavior ( Behavior behavior ) {
        this.behavior = behavior ;
    }

    protected String[] getModes() {
        return modes.clone();
    }

    @Override
    public PlanAlgorithm getPlanAlgoInstance() {

        final ChooseRandomLegModeForSubtour chooseRandomLegMode =
                new ChooseRandomLegModeForSubtour(
                        TripStructureUtils.getRoutingModeIdentifier(),
                        this.permissibleModesCalculator,
                        this.modes,
                        this.chainBasedModes,
                        MatsimRandom.getLocalInstance(), behavior, probaForChangeSingleTripMode, coordDist);
        return chooseRandomLegMode;
    }


}