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  /**
22   * Controller class for running monte carlo calculations. The controller (and its implementing classes) are responsible
23   * for determining whether or not the calculation should end.
24   */
25  public interface MarkovChainController {
26  
27      /**
28       * Returns whether or not to continue with the calculation.
29       * @param mc the Monte Carlo process this object is to control.
30       * @return true if the process can continue, false if it should stop after the current step.
31       */
32      boolean goOn(MarkovChainMonteCarlo mc);
33  }