repicea.simulation.REpiceaBinaryEventPredictor Maven / Gradle / Ivy
/*
* This file is part of the repicea library.
*
* Copyright (C) 2009-2019 Mathieu Fortin for Rouge-Epicea
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library is distributed with the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* Please see the license at http://www.gnu.org/copyleft/lesser.html.
*/
package repicea.simulation;
import java.util.Map;
import repicea.stats.StatisticalUtility;
/**
* This REpiceaBinaryEventPredictor class implements logistic and other models that aim at
* predicting the occurrence of binary event.
* @author Mathieu Fortin - November 2012
* @param a class that represents the stand or the plot
* @param a class that represents the tree
*/
public abstract class REpiceaBinaryEventPredictor extends REpiceaPredictor {
private static final long serialVersionUID = 20131015L;
protected REpiceaBinaryEventPredictor(boolean isParametersVariabilityEnabled, boolean isRandomEffectsVariabilityEnabled, boolean isResidualVariabilityEnabled) {
super(isParametersVariabilityEnabled, isRandomEffectsVariabilityEnabled, isResidualVariabilityEnabled);
}
/**
* This method returns the probability of event for a particular tree represented by the parameter
* "tree".
* @param stand a S-derived instance
* @param tree a T-derived instance
* @param parms some additional parameters
* @return the event probability
*/
public abstract double predictEventProbability(S stand, T tree, Map parms);
/**
* This method returns the probability of event for a particular tree represented by the parameter
* "tree".
* @param stand a S-derived instance
* @param tree a T-derived instance
* @return the event probability
*/
public final double predictEventProbability(S stand, T tree) {
return predictEventProbability(stand, tree, null);
}
/**
* This method returns either a boolean if isResidualVariabilityEnabled was set to true
* or the probability otherwise.
* @param stand a S-derived instance
* @param tree a T-derived instance
* @return a Boolean or a double
*/
public final Object predictEvent(S stand, T tree) {
return predictEvent(stand, tree, null);
}
/**
* This method returns either a boolean if isResidualVariabilityEnabled was set to true
* or the probability otherwise.
* @param stand a S-derived instance
* @param tree a T-derived instance
* @param parms some additional parameters
* @return a Boolean or a double
*/
public Object predictEvent(S stand, T tree, Map parms) {
double eventProbability = predictEventProbability(stand, tree, parms);
if (eventProbability < 0 || eventProbability > 1) {
return null;
} else if (isResidualVariabilityEnabled) {
double residualError = StatisticalUtility.getRandom().nextDouble();
if (residualError < eventProbability) {
return true;
} else {
return false;
}
} else {
return eventProbability;
}
}
// /**
// * This method scans the parameters and finds the first object that is an instance of
// * this class.
// * @param clazz the class of object to be looked for
// * @param parms the parameters
// * @return the first object of this class or null otherwise
// */
// public static Object findFirstParameterOfThisClass(Class clazz, Object... parms) {
// if (parms != null && parms.length > 0) {
// for (Object obj : parms) {
// if (clazz.isInstance(obj)) {
// return obj;
// }
// }
// }
// return null;
// }
}