//---------------------------------------------------------------------
/// <summary>
/// initialize the cohort dictionary for this stand's evaluation
/// </summary>
/*
private void init_dictionary(Stand stand, Dictionary<string, int> stand_cohorts) {
stand_cohorts.Clear();
List<ActiveSite> sites = stand.GetSites();
//loop through the sites gathering the species (only the ones involved in the rule_list) into a dictionary.
//count the number of occurrences for each species-age pairing.
foreach (ActiveSite site in sites) {
//tally the occurrences of the cohorts:
//if the cohort is the correct species and within the correct age range
AgeCohort.ISiteCohorts site_cohorts = (AgeCohort.ISiteCohorts) Model.Core.SuccessionCohorts[site];
foreach (InclusionRule rule in rule_list)
{
//part of the dictionary's key will be a grouping of the species names listed
string key_start = "";
foreach(string species in rule.SpeciesList)
{
key_start += species + " ";
}
//flag for if a species matching the age requirements (for this rule) is found in the site or not
bool found_one = false;
//get species cohorts by using this rule's species_indices (in case more than 1 species is listed)
//loop through all species indecis, will build dictionary
foreach (int index in rule.SpeciesIndexList)
{
AgeCohort.ISpeciesCohorts species_cohorts = site_cohorts[Model.Core.Species[index]];
//get enumeration of the cohorts if the species_cohorts is not null
//if (species_cohorts != null)
//{
//IEnumerator<AgeCohort.ICohort> cohort_enum = species_cohorts.GetEnumerator();
//loop while you still can (will return false when it is at the end of the enum)
//while (cohort_enum.MoveNext())
foreach(AgeCohort.ICohort cohort in species_cohorts)
{
//AgeCohort.ICohort cohort = cohort_enum.Current;
// if the cohort fits the rule, tally it in the dictionary.
if (rule.SpeciesList.Contains(cohort.Species.Name) && rule.RuleAgeRange.Contains(cohort.Age)) {
try {
// add this entry to the dictionary with a count of 1
stand_cohorts.Add(get_key(key_start, rule.RuleAgeRange), 1);
}
// if there is an argument exception, then must increment hit-count for this cohort
catch(ArgumentException) {
// increment value for this cohort
stand_cohorts[get_key(key_start, rule.RuleAgeRange)]++;
}
//break out of loop because this site has shown that it contains a cohort matching that rule.
//also note that it should break out of the rule because it has already been met.
found_one = true;
break;
}
}
//}
//break out of this loop if a species matching age requirements (for this rule) has already been found in this site
if (found_one) {
break;
}
}
}
}
}
//---------------------------------------------------------------------
/// <summary>
/// make a string key for the dictionary.
/// format is <species> <age range start> <age range end>
/// </summary>
private string get_key(string key_start, AgeRange age_range) {
//the key is formed by concatenating the key_start (species list) with the age range parameters
string key = key_start + age_range.Start + " " + age_range.End;
return key;
}
*/
//---------------------------------------------------------------------
// Re-written by R. Scheller to simply and speed the stand processing.
private bool CheckRule(Stand stand, InclusionRule rule)
{
//bool meets = false;
int numCellsValid = 0;
int numActiveCells = 0;
int[] otherSpeciesCount = new int[Model.Core.Species.Count];
foreach(Site site in stand.GetSites())
{
if(!site.IsActive)
continue;
numActiveCells++;
bool goodSite = false;
bool otherSpecies = false;
AgeCohort.ISiteCohorts siteCohorts = (AgeCohort.ISiteCohorts) Model.Core.SuccessionCohorts[site];
foreach(ISpecies species in Model.Core.Species)
{
if(siteCohorts[species] != null)
{
foreach (AgeCohort.ICohort cohort in siteCohorts[species])
{
if (rule.SpeciesList.Contains(species.Name) && rule.RuleAgeRange.Contains(cohort.Age))
{
goodSite = true;
}
// Some other species, NOT in the list
if (!rule.SpeciesList.Contains(species.Name) && rule.RuleAgeRange.Contains(cohort.Age))
{
otherSpecies = true;
}
}
if(otherSpecies)
otherSpeciesCount[species.Index]++;
}
}
if(goodSite)
numCellsValid++;
} // done looping through sites
if(numCellsValid == 0) // There are no good cells whatsoever.
return false;
bool highest = true;
//If percent != -1, compare to the Percent of Cells
if (rule.PercentOfCells != -1)
{
double targetNumCells = (double) numActiveCells * rule.PercentOfCells;
if(numCellsValid > targetNumCells)
{
//UI.WriteLine(" numGoodSites={0}, targetNumCells={1}", numCellsValid, targetNumCells);
return true;
}
}
//If percent == -1, use 'highest' evaluation algorithm
else
{
for(int i = 0; i < Model.Core.Species.Count; i++)
{
if(numCellsValid < otherSpeciesCount[i])
highest = false;
//UI.WriteLine(" numGoodSites={0}, otherSppCnt={1}, true? {2}", numCellsValid, otherSpeciesCount[i], highest);
}
}
return highest;
}
//---------------------------------------------------------------------
/// <summary>
/// initialize the cohort dictionary for this stand's evaluation
/// </summary>
/*
private void init_dictionary(Stand stand, Dictionary<string, int> stand_cohorts) {
stand_cohorts.Clear();
List<ActiveSite> sites = stand.GetSites();
//loop through the sites gathering the species (only the ones involved in the rule_list) into a dictionary.
//count the number of occurrences for each species-age pairing.
foreach (ActiveSite site in sites) {
//tally the occurrences of the cohorts:
//if the cohort is the correct species and within the correct age range
AgeCohort.ISiteCohorts site_cohorts = (AgeCohort.ISiteCohorts) Model.Core.SuccessionCohorts[site];
foreach (InclusionRule rule in rule_list)
{
//part of the dictionary's key will be a grouping of the species names listed
string key_start = "";
foreach(string species in rule.SpeciesList)
{
key_start += species + " ";
}
//flag for if a species matching the age requirements (for this rule) is found in the site or not
bool found_one = false;
//get species cohorts by using this rule's species_indices (in case more than 1 species is listed)
//loop through all species indecis, will build dictionary
foreach (int index in rule.SpeciesIndexList)
{
AgeCohort.ISpeciesCohorts species_cohorts = site_cohorts[Model.Core.Species[index]];
//get enumeration of the cohorts if the species_cohorts is not null
//if (species_cohorts != null)
//{
//IEnumerator<AgeCohort.ICohort> cohort_enum = species_cohorts.GetEnumerator();
//loop while you still can (will return false when it is at the end of the enum)
//while (cohort_enum.MoveNext())
foreach(AgeCohort.ICohort cohort in species_cohorts)
{
//AgeCohort.ICohort cohort = cohort_enum.Current;
// if the cohort fits the rule, tally it in the dictionary.
if (rule.SpeciesList.Contains(cohort.Species.Name) && rule.RuleAgeRange.Contains(cohort.Age)) {
try {
// add this entry to the dictionary with a count of 1
stand_cohorts.Add(get_key(key_start, rule.RuleAgeRange), 1);
}
// if there is an argument exception, then must increment hit-count for this cohort
catch(ArgumentException) {
// increment value for this cohort
stand_cohorts[get_key(key_start, rule.RuleAgeRange)]++;
}
//break out of loop because this site has shown that it contains a cohort matching that rule.
//also note that it should break out of the rule because it has already been met.
found_one = true;
break;
}
}
//}
//break out of this loop if a species matching age requirements (for this rule) has already been found in this site
if (found_one) {
break;
}
}
}
}
}
//---------------------------------------------------------------------
/// <summary>
/// make a string key for the dictionary.
/// format is <species> <age range start> <age range end>
/// </summary>
private string get_key(string key_start, AgeRange age_range) {
//the key is formed by concatenating the key_start (species list) with the age range parameters
string key = key_start + age_range.Start + " " + age_range.End;
return key;
}
*/
//---------------------------------------------------------------------
private bool check_rule(Stand stand, InclusionRule rule)
{
//bool meets = false;
int numCellsValid = 0;
int numActiveCells = 0;
int[] otherSpeciesCount = new int[Model.Core.Species.Count];
foreach(Site site in stand.GetSites())
{
if(!site.IsActive)
continue;
numActiveCells++;
bool goodSite = false;
bool otherSpecies = false;
AgeCohort.ISiteCohorts siteCohorts = (AgeCohort.ISiteCohorts) Model.Core.SuccessionCohorts[site];
foreach(ISpecies species in Model.Core.Species)
{
foreach (AgeCohort.ICohort cohort in siteCohorts[species])
{
if (rule.SpeciesList.Contains(species.Name) && rule.RuleAgeRange.Contains(cohort.Age))
{
goodSite = true;
}
// Some other species, NOT in the list
if (!rule.SpeciesList.Contains(species.Name) && rule.RuleAgeRange.Contains(cohort.Age))
{
otherSpecies = true;
}
}
if(otherSpecies)
otherSpeciesCount[species.Index]++;
}
if(goodSite)
numCellsValid++;
} // done looping through sites
bool highest = true;
if (rule.PercentOfCells != -1) {
if(numCellsValid > (double) numActiveCells * rule.PercentOfCells)
return true;
}
//if percent != -1, use 'highest' evaluation algorithm
else
{
for(int i = 0; i < Model.Core.Species.Count; i++)
if(numCellsValid < otherSpeciesCount[i])
highest = false;
}
return highest;
}
//---------------------------------------------------------------------
/// <summary>
/// calculate the boolean expression for the given rule and stand parameters.
/// </summary>
/// <returns>
/// the truth value.
/// </returns>
private bool check_rule(Stand stand, Dictionary<string, int> stand_cohorts, InclusionRule rule, string key, int site_count, double percent) {
bool meets = false;
//if percent is a value (-1 is number for 'highest') then return truth as normal calculation
if (percent != -1) {
meets = (stand_cohorts[key] > site_count * percent);
}
//if percent != -1, use 'highest' evaluation algorithm
else {
//compare the number of cohorts covered by this rule (found in stand_cohorts[key]) to all other species (for all their cohorts)
//dictionary for other species
Dictionary<string, int> other_species = new Dictionary<string, int>();
List<ActiveSite> sites = stand.GetSites();
//fill this other dictionary, grouped by other species in the stand
foreach (ActiveSite site in sites) {
Cohorts.TypeIndependent.ISiteCohorts cohorts = Model.Core.SuccessionCohorts[site];
IList<ISpecies> species_present = cohorts.SpeciesPresent;
//loop through these species names. if it is a species name used in this rule, ignore it.
//if it is not a species name used in this rule, tally it in the dictionary
foreach (ISpecies species in species_present) {
//UI.WriteLine("new species:");
if (!rule.SpeciesList.Contains(species.Name)) {
try {
// add this entry to the dictionary with a count of 1
other_species.Add(species.Name, 1);
//UI.WriteLine("found species {0}", species.Name);
}
// if there is an argument exception, then must increment hit-count for this cohort
catch (ArgumentException) {
other_species[species.Name]++;
//UI.WriteLine("incrementing {0} to {1}", species.Name, other_species[species.Name]);
}
}
}
}
//now check whole dictionary against rule
foreach (KeyValuePair<string, int> kvp in other_species) {
//if there is another species that appears more often than this grouping of cohorts (defined by the rule)
//then the rule fails.
if (stand_cohorts[key] < kvp.Value) {
//UI.WriteLine("FAILURE: {0} has {1} and {2} only has {3}", kvp.Key, kvp.Value, key, stand_cohorts[key]);
return false;
}
//for testing only
/* else {
UI.WriteLine("SUCCESS: {0} has {1} and {2} only has {3}", key, stand_cohorts[key], kvp.Key, kvp.Value);
} */
}
//if the loop went all the way through, then the rule is met, return true
meets = true;
}
//return truth value
return meets;
}
