Skip to content

Commit

Permalink
Updates docs.
Browse files Browse the repository at this point in the history
Signed-off-by: Manoel Campos <manoelcampos@gmail.com>
  • Loading branch information
manoelcampos committed Aug 29, 2018
1 parent 54c4167 commit 10e9a86
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<p align="center">
<b><a href="#overview">Overview</a></b>
|
<b><a href="#exclusive-features">Exclusive Features</a></b>
<b><a href="#main-exclusive-features">Exclusive Features</a></b>
|
<b><a href="#projects-structure">Structure</a></b>
|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ private int getNextUtilizationIndex(final double time) {
}

/**
* Gets the number of {@link #utilization} samples in between two indexes.
* Gets the number of {@link #utilization} samples between two indexes.
*
* <p>
* Since the utilization array is implemented as a circular list,
Expand All @@ -239,9 +239,10 @@ private int getNextUtilizationIndex(final double time) {
* computing the size of the interval between the two indexes.
* </p>
*
* <p>Think of the indexes of the circular list as being 0, 1, 2, 3 ...... 286, 287, 0, 1, 2, 3 ...
* <p>Consider that the trace file has 288 lines, indexed from line 0 to 287.
* Think of the trace as a circular list with indexes 0, 1, 2, 3 ...... 286, 287, 0, 1, 2, 3 ...
* If the start index is 286 and the end index 2, then the interval size is 4
* (the number of indexed in between 286 and 2).
* (the number of indexes between 286 and 2).
*
* </p>
* @param startIndex the start index in the interval
Expand All @@ -256,7 +257,9 @@ protected final int getIntervalSize(final int startIndex, final int endIndex) {
}

/**
* Gets the time interval (in seconds) in which precise utilization can be got from the workload file.
* Gets the time interval (in seconds) in which precise
* utilization can be got from the workload file.
*
* <p>That means if the {@link #getUtilization(double)} is called
* passing any time that is multiple of this scheduling interval,
* the utilization returned will be the value stored for that
Expand Down

0 comments on commit 10e9a86

Please sign in to comment.