org.matsim.analysis.IterationStopWatch Class Reference

Public Member Functions
	IterationStopWatch ()
void	reset ()
void	beginIteration (final int iteration)
void	beginOperation (final String identifier)
void	endOperation (final String identifier)
void	endIteration ()
void	timestamp (final String identifier)
void	writeSeparatedFile (final String filename, final String delimiter)
void	writeGraphFile (String filename)

Static Public Attributes
static final String	OPERATION_ITERATION = "iteration"
static final String	OPERATION_OTHER = "other"

Private Member Functions
void	ensureIdentifier (final String identifier)
void	ensureOperation (final String identifier)
String	formatMilliTime (final Long millis)

Private Attributes
Integer	iteration = null
final Map< Integer, Map< String, Long > >	iterations
final List< String >	identifiers
final List< String >	operations
Map< String, Long >	currentIterationValues
int	nextIdentifierPosition = 0
int	nextOperationPosition = 0
final DateFormat	formatter = new SimpleDateFormat("HH:mm:ss")
Stack< String >	currentMeasuredOperations
Map< String, List< String > >	currentIterationChildren
final Map< Integer, Map< String, List< String > > >	children

Detailed Description

This class provides a mechanism similar to a stop watch, allowing to measure the duration of operations and remembering time stamps. The class collects all the data and provides a simple analysis of the time stamps and durations for operations for each iteration in the simulation. This analysis can be dumped to console or to a file using the write()-methods.

Author

mrieser

Definition at line 43 of file IterationStopWatch.java.

Constructor & Destructor Documentation

IterationStopWatch()

org.matsim.analysis.IterationStopWatch.IterationStopWatch

(

)

Creates a new IterationStopWatch.

Definition at line 84 of file IterationStopWatch.java.

                                {
        this.iterations = new LinkedHashMap<>();
        this.identifiers = new LinkedList<>();
        this.operations = new LinkedList<>();
        this.currentIterationValues = null;
        this.children = new LinkedHashMap<>();
    }

Member Function Documentation

reset()

void org.matsim.analysis.IterationStopWatch.reset

(

)

Resets the stop watch, deleting all gathered values.

Definition at line 95 of file IterationStopWatch.java.

                        {
        this.nextIdentifierPosition = 0;
        this.nextOperationPosition = 0;
        this.iteration = null;
        this.currentIterationValues = null;
        this.iterations.clear();
        this.identifiers.clear();
        this.operations.clear();
        this.currentMeasuredOperations.clear();
        this.currentIterationChildren.clear();
        this.children.clear();
    }

beginIteration()

void org.matsim.analysis.IterationStopWatch.beginIteration

(

final int

iteration

)

Sets the current iteration, so that the times measured using beginOperation(String), endOperation(String) and timestamp(String) are assigned to the correct iteration for the analysis.

Definition at line 113 of file IterationStopWatch.java.

References org.matsim.analysis.IterationStopWatch.beginOperation(), and org.matsim.analysis.IterationStopWatch.iteration.

                                                    {
        this.iteration = iteration;
        if (this.iterations.get(this.iteration) == null) {
            this.currentIterationValues = new HashMap<>();
            this.iterations.put(this.iteration, this.currentIterationValues);
            this.nextIdentifierPosition = 0;
            this.nextOperationPosition = 0;
            this.currentMeasuredOperations = new Stack<>();
            this.currentIterationChildren = new HashMap<>();
            this.children.put(this.iteration, this.currentIterationChildren);
        }
        this.beginOperation(OPERATION_ITERATION);
    }

Here is the call graph for this function:

beginOperation()

void org.matsim.analysis.IterationStopWatch.beginOperation

(

final String

identifier

)

Tells the stop watch that an operation begins.

Parameters

identifier

The name of the beginning operation.

Definition at line 132 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.beginIteration().

                                                        {

        if (identifier.equals(OPERATION_OTHER)) {
            throw new RuntimeException("Identifier " + OPERATION_OTHER + " is reserved! Please use another one. Aborting!");
        }

        String ident = "BEGIN " + identifier;
        ensureIdentifier(ident);
        this.currentIterationValues.put(ident, System.currentTimeMillis());

        this.currentIterationChildren.put(identifier, new ArrayList<>());

        // check whether this operation has a parent operation
        if (!this.currentMeasuredOperations.isEmpty()) {
            String parent = this.currentMeasuredOperations.peek();
            this.currentIterationChildren.get(parent).add(identifier);
        }

        // add ident to stack
        this.currentMeasuredOperations.push(identifier);
    }

endOperation()

void org.matsim.analysis.IterationStopWatch.endOperation

(

final String

identifier

)

Tells the stop watch that an operation ends. The operation must have been started before with beginOperation(String).

Parameters

identifier

The name of the ending operation.

Definition at line 160 of file IterationStopWatch.java.

References org.matsim.analysis.IterationStopWatch.ensureIdentifier(), and org.matsim.analysis.IterationStopWatch.ensureOperation().

Referenced by org.matsim.analysis.IterationStopWatch.endIteration().

                                                      {
        String ident = "END " + identifier;
        ensureIdentifier(ident);
        ensureOperation(identifier);
        this.currentIterationValues.put(ident, System.currentTimeMillis());


        this.currentMeasuredOperations.pop();
    }

Here is the call graph for this function:

endIteration()

void org.matsim.analysis.IterationStopWatch.endIteration

(

)

Definition at line 170 of file IterationStopWatch.java.

References org.matsim.analysis.IterationStopWatch.endOperation().

                               {
        this.endOperation(OPERATION_ITERATION);
    }

Here is the call graph for this function:

timestamp()

void org.matsim.analysis.IterationStopWatch.timestamp

(

final String

identifier

)

Tells the stop watch that a special event happened, for which the time should be remembered.

Parameters

identifier

The name of the event.

Definition at line 179 of file IterationStopWatch.java.

References org.matsim.analysis.IterationStopWatch.ensureIdentifier().

                                                   {
        ensureIdentifier(identifier);
        this.currentIterationValues.put(identifier, System.currentTimeMillis());
    }

Here is the call graph for this function:

writeSeparatedFile()

void org.matsim.analysis.IterationStopWatch.writeSeparatedFile	(	final String	filename,
		final String	delimiter
	)

Writes the gathered data into a file.

Parameters

filename	The name of a file where to write the gathered data.
delimiter	The delimiter to be used as field separator.

Definition at line 190 of file IterationStopWatch.java.

References org.matsim.analysis.IterationStopWatch.formatMilliTime(), org.matsim.core.utils.io.IOUtils.getBufferedWriter(), and org.matsim.core.utils.misc.Time.writeTime().

                                                                                  {
        try (BufferedWriter writer = IOUtils.getBufferedWriter(filename)) {

            // print header
            writer.write("iteration");
            for (String identifier : this.identifiers) {
                writer.write(delimiter);
                writer.write(identifier);
            }
            writer.write(delimiter);
            for (String identifier : this.operations) {
                writer.write(delimiter);
                writer.write(identifier);
            }
            writer.write('\n');

            // print data
            for (Map.Entry<Integer, Map<String, Long>> entry : this.iterations.entrySet()) {
                Integer iteration = entry.getKey();
                Map<String, Long> data = entry.getValue();
                // iteration
                writer.write(iteration.toString());
                // identifiers
                for (String identifier : this.identifiers) {
                    Long time = data.get(identifier);
                    writer.write(delimiter);
                    writer.write(formatMilliTime(time));
                }
                // blank separator
                writer.write(delimiter);
                // durations of operations
                for (String identifier: this.operations) {
                    Long startTime = data.get("BEGIN " + identifier);
                    Long endTime = data.get("END " + identifier);
                    writer.write(delimiter);
                    if (startTime != null && endTime != null) {
                        double diff = (endTime - startTime) / 1000.0;
                        writer.write(Time.writeTime(diff));
                    }
                }

                // finish
                writer.write("\n");
            }
            writer.flush();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

Here is the call graph for this function:

writeGraphFile()

void org.matsim.analysis.IterationStopWatch.writeGraphFile

(

String

filename

)

Writes the gathered data as graph into a png file.

Parameters

filename

The name of a file where to write the gathered data.

Definition at line 245 of file IterationStopWatch.java.

References org.matsim.core.utils.charts.ChartUtil.addMatsimLogo(), org.matsim.core.utils.charts.StackedBarChart.addSeries(), org.matsim.core.utils.charts.StackedBarChart.getChart(), org.matsim.analysis.IterationStopWatch.iterations, and org.matsim.core.utils.charts.ChartUtil.saveAsPng().

                                                {

        int iterations = this.iterations.entrySet().size();
        Map<String, double[]> arrayMap = new HashMap<>();
        for (String identifier : this.operations) arrayMap.put(identifier, new double[iterations]);

        int iter = 0;
        for(Entry<Integer, Map<String, Long>> entry : this.iterations.entrySet()) {
            Map<String, Long> data = entry.getValue();

            // children map of current iteration
            Map<String, List<String>> childrenMap = this.children.get(entry.getKey());

            // durations of operations
            for (String identifier : this.operations) {
                Long startTime = data.get("BEGIN " + identifier);
                Long endTime = data.get("END " + identifier);
                if (startTime != null && endTime != null) {
                    double diff = (endTime - startTime);

                    /*
                     * If the operation has children, subtract their durations since they are
                     * also included in the plot. Otherwise, their duration would be counted twice.
                     */
                    for (String child : childrenMap.get(identifier)) {
                        Long childStartTime = data.get("BEGIN " + child);
                        Long childEndTime = data.get("END " + child);
                        diff -= (childEndTime - childStartTime);
                    }

                    arrayMap.get(identifier)[iter] = diff / 1000.0;
                } else arrayMap.get(identifier)[iter] = 0.0;
            }
            iter++;
        }

        String title = "Computation time distribution per iteration";
        String xAxisLabel = "iteration";
        String yAxisLabel = "seconds";

        String[] categories = new String[this.iterations.size()];
        int index = 0;
        for (int iteration : this.iterations.keySet()) {
            categories[index] = String.valueOf(iteration);
            index++;
        }

        StackedBarChart chart = new StackedBarChart(title, xAxisLabel, yAxisLabel, categories);
        chart.addMatsimLogo();

        /*
         * Rotate x-axis labels by 90° which should allow more of them to be plotted before overlapping.
         * However, a more general solution that also is able to skip labels would be nice.
         * cdobler nov'13
         */
        chart.getChart().getCategoryPlot().getDomainAxis().setCategoryLabelPositions(CategoryLabelPositions.UP_90);

        double[] iterationData = null;
        for (String operation : this.operations) {
            double[] data = arrayMap.get(operation);
            if (operation.equals(OPERATION_ITERATION)) {
                iterationData = data;
            } else {
                chart.addSeries(operation, data);
            }
        }
        if (iterationData != null) {
            double[] otherData = new double[iterations];
            System.arraycopy(iterationData, 0, otherData, 0, iterations);
            chart.addSeries(OPERATION_OTHER, otherData);
        }

        chart.saveAsPng(filename + ".png", 1024, 768);
    }

Here is the call graph for this function:

ensureIdentifier()

void org.matsim.analysis.IterationStopWatch.ensureIdentifier ( final String  identifier )

private

Make sure the given identifier exists in our collection. If it is missing, insert it at the correct place. "Correct" means that it tries to insert this identifier right after the last-requested identifier. This should help to write the gathered data out in a natural way.

Definition at line 325 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.endOperation(), and org.matsim.analysis.IterationStopWatch.timestamp().

                                                           {
        int pos = this.identifiers.indexOf(identifier);
        if (pos == -1) {
            this.identifiers.add(this.nextIdentifierPosition, identifier);
            this.nextIdentifierPosition++;
        } else {
            this.nextIdentifierPosition = pos + 1;
        }
    }

ensureOperation()

void org.matsim.analysis.IterationStopWatch.ensureOperation ( final String  identifier )

private

Does the same as ensureIdentifier(String), but for operation-identifiers.

Definition at line 338 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.endOperation().

                                                          {
        int pos = this.operations.indexOf(identifier);
        if (pos == -1) {
            this.operations.add(this.nextOperationPosition, identifier);
            this.nextOperationPosition++;
        } else {
            this.nextOperationPosition = pos + 1;
        }
    }

formatMilliTime()

String org.matsim.analysis.IterationStopWatch.formatMilliTime ( final Long  millis )

private

Formats the time given in milliseconds (e.g. returned by java.lang.System#currentTimeMillis()) nicely for output.

Parameters

millis

A time value in milliseconds

Returns

A String containing the formatted time, or an empty String if millis is null

Definition at line 355 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.writeSeparatedFile().

                                                      {
        if (millis == null) {
            return "";
        }
        return this.formatter.format(new Date(millis));
    }

Member Data Documentation

OPERATION_ITERATION

final String org.matsim.analysis.IterationStopWatch.OPERATION_ITERATION = "iteration"

static

Strings used to identify the operations in the IterationStopWatch.

Definition at line 47 of file IterationStopWatch.java.

OPERATION_OTHER

final String org.matsim.analysis.IterationStopWatch.OPERATION_OTHER = "other"

static

Definition at line 52 of file IterationStopWatch.java.

iteration

Integer org.matsim.analysis.IterationStopWatch.iteration = null

private

The current iteration number, or null if not yet initialized.

Definition at line 55 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.beginIteration().

iterations

final Map<Integer, Map<String, Long> > org.matsim.analysis.IterationStopWatch.iterations

private

The main collection, where all the gathered data is stored.

Definition at line 58 of file IterationStopWatch.java.

Referenced by org.matsim.analysis.IterationStopWatch.writeGraphFile().

identifiers

final List<String> org.matsim.analysis.IterationStopWatch.identifiers

private

A list of identifiers used to enumerate time stamps.

Definition at line 61 of file IterationStopWatch.java.

operations

final List<String> org.matsim.analysis.IterationStopWatch.operations

private

A list of identifiers used to enumerate operations.

Definition at line 64 of file IterationStopWatch.java.

currentIterationValues

Map<String, Long> org.matsim.analysis.IterationStopWatch.currentIterationValues

private

A cache for easy access to the current object in iterations.

Definition at line 67 of file IterationStopWatch.java.

nextIdentifierPosition

int org.matsim.analysis.IterationStopWatch.nextIdentifierPosition = 0

private

The position within identifiers, where the next identifier is expected.

Definition at line 70 of file IterationStopWatch.java.

nextOperationPosition

int org.matsim.analysis.IterationStopWatch.nextOperationPosition = 0

private

The position within operations, where the next identifier is expected.

Definition at line 73 of file IterationStopWatch.java.

formatter

final DateFormat org.matsim.analysis.IterationStopWatch.formatter = new SimpleDateFormat("HH:mm:ss")

private

A formatter for dates, used when writing out the data.

Definition at line 76 of file IterationStopWatch.java.

currentMeasuredOperations

Stack<String> org.matsim.analysis.IterationStopWatch.currentMeasuredOperations

private

data structures to identify nested operations

Definition at line 79 of file IterationStopWatch.java.

currentIterationChildren

Map<String, List<String> > org.matsim.analysis.IterationStopWatch.currentIterationChildren

private

Definition at line 80 of file IterationStopWatch.java.

children

final Map<Integer, Map<String, List<String> > > org.matsim.analysis.IterationStopWatch.children

private

Definition at line 81 of file IterationStopWatch.java.

---

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

• analysis/IterationStopWatch.java