Public Member Functions
	Bins (double interval, double maxVal, String desc)

void	addValues (double[] values, double[] weights)

void	addVal (double value, double weight)

void	clear ()

void	plotBinnedDistribution (String path, String xLabel, String xUnit)

double []	getBins ()

void	setBins (double[] bins)

double	getInterval ()

void	setInterval (double interval)

double	median (List< Double > values)

double	mean (List< Double > values)

double	weightedMean (List< Double > values, List< Double > weights)

double	weightedMean (Double[] values, Double[] weights)

double	getMax (List< Double > values)

double	getMax (Double[] values)

Protected Attributes
double	interval

int	numberOfBins

double	maxVal

String	desc

List< BinEntry >	entries = new Vector<BinEntry>()

double []	bins

Private Member Functions
double	median (Double [] values)

Static Private Attributes
static final Logger	log = LogManager.getLogger(Bins.class)

Detailed Description

Definition at line 34 of file Bins.java.

Constructor & Destructor Documentation

◆ Bins()

org.matsim.analysis.Bins.Bins	(	double	interval,
		double	maxVal,
		String	desc
	)

Definition at line 45 of file Bins.java.

References org.matsim.analysis.Bins.desc, org.matsim.analysis.Bins.interval, org.matsim.analysis.Bins.maxVal, and org.matsim.analysis.Bins.numberOfBins.

                                                              {
         this.interval = interval;
         this.maxVal = maxVal;
         this.numberOfBins = (int)Math.ceil(maxVal / interval);
         this.desc = desc;
         this.bins = new double[this.numberOfBins];
     }

Member Function Documentation

◆ addValues()

void org.matsim.analysis.Bins.addValues	(	double []	values,
		double []	weights
	)

Definition at line 52 of file Bins.java.

References org.matsim.analysis.Bins.addVal().

                                                              {
         for (int index = 0; index < values.length; index++) {
             this.addVal(values[index], weights[index]);
         }
     }

Here is the call graph for this function:

◆ addVal()

void org.matsim.analysis.Bins.addVal	(	double	value,
		double	weight
	)

Definition at line 58 of file Bins.java.

Referenced by org.matsim.analysis.Bins.addValues().

                                                     {
         int index = (int)Math.floor(value / interval);
         // values > maximum value are assigned to the last bin
         if (value >= maxVal) {
             index = this.numberOfBins -1; 
         }
 
         // values < 0.0 value are assigned to the first bin
         if (value < 0.0) {
             log.error("Value < 0.0 received");
             index = 0;
         }
         
         this.bins[index] += weight;
         this.entries.add(new BinEntry(value, weight));
     }

◆ clear()

void org.matsim.analysis.Bins.clear ( )

Definition at line 75 of file Bins.java.

References org.matsim.analysis.Bins.numberOfBins.

                         {
         this.entries.clear();
         this.bins = new double[this.numberOfBins];
     }

◆ plotBinnedDistribution()

void org.matsim.analysis.Bins.plotBinnedDistribution	(	String	path,
		String	xLabel,
		String	xUnit
	)

Definition at line 80 of file Bins.java.

References org.matsim.core.utils.charts.BarChart.addSeries(), org.matsim.core.utils.io.IOUtils.getBufferedWriter(), org.matsim.analysis.Bins.getMax(), org.matsim.analysis.Bins.median(), org.matsim.analysis.Bins.numberOfBins, org.matsim.core.utils.charts.ChartUtil.saveAsPng(), and org.matsim.analysis.Bins.weightedMean().

                                                                                  {
         String [] categories  = new String[this.numberOfBins];
         for (int i = 0; i < this.numberOfBins; i++) {
             categories[i] = Integer.toString(i);
         }
         Double[] values = new Double[this.entries.size()];
         Double[] weights = new Double[this.entries.size()];
 
         for (int index = 0; index < this.entries.size(); index++) {
             values[index] = this.entries.get(index).getValue();
             weights[index] = this.entries.get(index).getWeight();
         }
 
         DecimalFormat formatter = new DecimalFormat("0.0000");
         String s = xLabel + " " +
         "[interval = " + formatter.format(this.interval) + xUnit + "]" +
         "[number of entries = " + this.entries.size() + "]" +
         "[mean = " + formatter.format(this.weightedMean(values, weights)) + xUnit + "]" +
         "[median = " + formatter.format(this.median(values)) + xUnit + "]" +
         "[max = " + formatter.format(this.getMax(values)) + xUnit + "]";
 
         BarChart chart =
             new BarChart(desc, s , "#", categories);
         chart.addSeries("Bin size", this.bins);
         chart.saveAsPng(path + desc + ".png", 1600, 800);
 
         try {
             BufferedWriter out = IOUtils.getBufferedWriter(path + desc + ".txt");
             out.write("Bin [interval = " + this.interval + " " + xUnit  + "]\t" + "#" + "\n");
             for (int j = 0; j < bins.length;  j++) {
                 out.write(j + "\t" + bins[j] + "\n");
             }
             out.flush();
             out.close();
         } catch (IOException e) {
             e.printStackTrace();
         }
     }

Here is the call graph for this function:

◆ getBins()

double [] org.matsim.analysis.Bins.getBins ( )

Definition at line 118 of file Bins.java.

References org.matsim.analysis.Bins.bins.

                               {
         return bins;
     }

◆ setBins()

void org.matsim.analysis.Bins.setBins ( double [] bins )

Definition at line 121 of file Bins.java.

References org.matsim.analysis.Bins.bins.

                                        {
         this.bins = bins;
     }

◆ getInterval()

double org.matsim.analysis.Bins.getInterval ( )

Definition at line 125 of file Bins.java.

References org.matsim.analysis.Bins.interval.

                                 {
         return interval;
     }

◆ setInterval()

void org.matsim.analysis.Bins.setInterval ( double interval )

Definition at line 128 of file Bins.java.

References org.matsim.analysis.Bins.interval.

                                              {
         this.interval = interval;
     }

◆ median() [1/2]

double org.matsim.analysis.Bins.median ( Double [] values )

private

Definition at line 132 of file Bins.java.

Referenced by org.matsim.analysis.Bins.plotBinnedDistribution().

                                             {
         List<Double> list = new Vector<Double>();
 
         Collections.addAll(list, values);
         return median(list);
     }

◆ median() [2/2]

double org.matsim.analysis.Bins.median ( List< Double > values )

Definition at line 139 of file Bins.java.

                                               {
 
         if (values.size() == 0) return 0.0;
 
         Collections.sort(values);
         if (values.size() % 2 != 0) {
             return values.get((values.size()+1)/2-1);
         }
         else {
             double lower = values.get(values.size()/2-1);
             double upper = values.get(values.size()/2);
             return (lower + upper) / 2.0;
         }
     }

◆ mean()

double org.matsim.analysis.Bins.mean ( List< Double > values )

Definition at line 154 of file Bins.java.

                                             {
         double sum = 0.0;
         int cnt = 0;
         if (values.size() == 0) return 0.0;
         for (Double value : values) {
             sum += value;
             cnt++;
         }
         return sum / cnt;
     }

◆ weightedMean() [1/2]

double org.matsim.analysis.Bins.weightedMean	(	List< Double >	values,
		List< Double >	weights
	)

Definition at line 165 of file Bins.java.

Referenced by org.matsim.analysis.Bins.plotBinnedDistribution().

                                                                           {
         return weightedMean(values.toArray(new Double[values.size()]), weights.toArray(new Double[weights.size()]));
     }

◆ weightedMean() [2/2]

double org.matsim.analysis.Bins.weightedMean	(	Double []	values,
		Double []	weights
	)

Definition at line 169 of file Bins.java.

                                                                   {
         double sumValues = 0.0;
         double sumWeights = 0.0;
         
         if (values.length == 0) return 0.0;
         
         if (values.length  != weights.length ) {
             log.info("size of weights and values not identical");
             return -1;
         }
         for (int index = 0; index < values.length; index++) {
             sumValues += (values[index] * weights[index]);
             sumWeights += weights[index];
         }
         return sumValues / sumWeights;
     }

◆ getMax() [1/2]

double org.matsim.analysis.Bins.getMax ( List< Double > values )

Definition at line 186 of file Bins.java.

Referenced by org.matsim.analysis.Bins.plotBinnedDistribution().

                                               {
         return getMax(values.toArray(new Double[values.size()]));
     }

◆ getMax() [2/2]

double org.matsim.analysis.Bins.getMax ( Double [] values )

Definition at line 190 of file Bins.java.

References org.matsim.analysis.Bins.maxVal.

                                           {
         double maxVal = Double.MIN_VALUE;
         for (Double v : values) {
             if (v > maxVal) {
                 maxVal = v;
             }
         }
         return maxVal;
     }

Member Data Documentation

◆ interval

double org.matsim.analysis.Bins.interval

protected

Definition at line 36 of file Bins.java.

Referenced by org.matsim.analysis.Bins.Bins(), org.matsim.analysis.Bins.getInterval(), and org.matsim.analysis.Bins.setInterval().

◆ numberOfBins

int org.matsim.analysis.Bins.numberOfBins

protected

Definition at line 37 of file Bins.java.

Referenced by org.matsim.analysis.Bins.Bins(), org.matsim.analysis.Bins.clear(), and org.matsim.analysis.Bins.plotBinnedDistribution().

◆ maxVal

double org.matsim.analysis.Bins.maxVal

protected

Definition at line 38 of file Bins.java.

Referenced by org.matsim.analysis.Bins.Bins(), and org.matsim.analysis.Bins.getMax().

◆ desc

String org.matsim.analysis.Bins.desc

protected

Definition at line 39 of file Bins.java.

Referenced by org.matsim.analysis.Bins.Bins().

◆ entries

List<BinEntry> org.matsim.analysis.Bins.entries = new Vector<BinEntry>()

protected

Definition at line 40 of file Bins.java.

◆ bins

double [] org.matsim.analysis.Bins.bins

protected

Definition at line 41 of file Bins.java.

Referenced by org.matsim.analysis.Bins.getBins(), and org.matsim.analysis.Bins.setBins().

◆ log

final Logger org.matsim.analysis.Bins.log = LogManager.getLogger(Bins.class)

staticprivate

Definition at line 43 of file Bins.java.

The documentation for this class was generated from the following file:

analysis/Bins.java

Public Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Bins()

Member Function Documentation

◆ addValues()

◆ addVal()

◆ clear()

◆ plotBinnedDistribution()

◆ getBins()

◆ setBins()

◆ getInterval()

◆ setInterval()

◆ median() [1/2]

◆ median() [2/2]

◆ mean()

◆ weightedMean() [1/2]

◆ weightedMean() [2/2]

◆ getMax() [1/2]

◆ getMax() [2/2]

Member Data Documentation

◆ interval

◆ numberOfBins

◆ maxVal

◆ desc

◆ entries

◆ bins

◆ log