View Javadoc

1   /*
2    * Copyright 2013 University of Glasgow.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package broadwick.montecarlo.markovchain.controller;
17  
18  import broadwick.montecarlo.markovchain.MarkovChainMonteCarlo;
19  
20  /**
21   * Create a default controller that run 1000 steps.
22   */
23  public class MarkovChainMaxNumStepController implements MarkovChainController {
24  
25      /**
26       * Create a Monte Carlo controller object that stops the run after a specified number of steps (a fixed path
27       * length).
28       */
29      public MarkovChainMaxNumStepController() {
30          this(1000);
31      }
32  
33      /**
34       * Create a Monte Carlo controller object that stops the run after a specified number of steps (a fixed path
35       * length).
36       * @param maxSteps the maximum length of the monte carlo chain.
37       */
38      public MarkovChainMaxNumStepController(final int maxSteps) {
39          this.maxSteps = maxSteps;
40      }
41  
42      @Override
43      public final boolean goOn(final MarkovChainMonteCarlo mc) {
44          return mc.getNumStepsTaken() < maxSteps;
45      }
46      private int maxSteps;
47  }