repicea.simulation.allometrycalculator.DbhComparator Maven / Gradle / Ivy
/*
* This file is part of the repicea library.
*
* Copyright (C) 2009-2014 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.allometrycalculator;
import java.util.Comparator;
import repicea.simulation.covariateproviders.treelevel.DbhCmProvider;
/**
* The DbhComparator class implements the Comparator interface for DbhCmProvider instances. It includes
* a HeightComparator instance for the multi-species case. Thereby it ensures that trees are first sorted
* by diameter and then if several species have similar diameter, they are further sorted by height.
* @author Mathieu Fortin - May 2014
*/
public class DbhComparator implements Comparator {
private final boolean ascending;
// private final HeightComparator heightComparator;
/**
* General constructor.
* @param ascending true for ascending sorting or false for descending sorting
*/
public DbhComparator(boolean ascending) {
this.ascending = ascending;
// heightComparator = new HeightComparator(ascending);
}
/**
* Default constructor for ascending comparison.
*/
public DbhComparator() {
this(true);
}
@Override
public int compare(DbhCmProvider arg0, DbhCmProvider arg1) {
if (ascending) {
if (arg0.getDbhCm() < arg1.getDbhCm()) {
return -1;
} else if (arg0.getDbhCm() == arg1.getDbhCm()) {
return 0; // MF2020-09-11 Bug fixed here: if all the trees are the same diameter, then the dominant height estimate was overestimated
// return compareForHeight(arg0, arg1);
} else {
return 1;
}
} else {
if (arg0.getDbhCm() < arg1.getDbhCm()) {
return 1;
} else if (arg0.getDbhCm() == arg1.getDbhCm()) {
return 0; // MF2020-09-11 Bug fixed here: if all the trees are the same diameter, then the dominant height estimate was overestimated
// return compareForHeight(arg0, arg1);
} else {
return -1;
}
}
}
// private int compareForHeight(DbhCmProvider arg0, DbhCmProvider arg1) {
// if (arg0 instanceof HeightMProvider && arg1 instanceof HeightMProvider) {
// return heightComparator.compare((HeightMProvider) arg0, (HeightMProvider) arg1);
// } else {
// return 0;
// }
// }
}