CalculateETA 1.6.2

CalculateETA

CalculateETA is a project to calculate estimated time to arrive on loops whether it is in single-thread or multi-thread applicatons.

Check out on NuGet gallery

Description

CalculateETA has methods to calculate estimated time to finish on loops. It calculates left count of iteration and multiply it with avarage passed time on the loop. On multi-thread applications, it has internal counter that increases everytime methods works via using that calculating left count of loop and multiply it with avarage passed time on the loop.

CalculateETA is optimized for CPU-intense applications.

Listed Methods

Counter Process

ResetCounter()

ResetCounterUint()

Returns true (value was not zero and resetted) or false (value was zero already) value. (bool)

Single-thread methods

¹

CalcETA(int? index, int? totalIndex, long? totalElapsedTimeInMs)

CalcETAUnsafe(int? index, int? totalIndex, long? totalElapsedTimeInMs)

CalcETA(uint? index, uint? totalIndex, long? totalElapsedTimeInMs)

CalcETAUnsafe(uint? index, uint? totalIndex, long? totalElapsedTimeInMs)

Returns null if any of parameter is null or returns estimated left time in milliseconds (long?)

• int?/uint? index: Current index of loop. Index must not be zero.

• int?/uint? totalIndex: Total index of loop.

• long? totalElapsedTimeInMs: Passed time of loop in milliseconds.

²

CalcETA(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETAUnsafe(int? index, int? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETA(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETAUnsafe(uint? index, uint? totalIndex, long? totalElapsedTicks, long? frequency)

Returns null if any of parameter is null or returns estimated left time in milliseconds (long?)

• int?/uint? index: Current index of loop. Index must not be zero.

• int?/uint? totalIndex: Total index of loop.

• long? totalElapsedTicks: Passed ticks of loop.

• long? frequency: Tick of frequency. Frequency must not be zero.

³

CalcETA(int? index, int? totalIndex, TimeSpan? timeSpan)

CalcETAUnsafe(int? index, int? totalIndex, TimeSpan? timeSpan)

CalcETA(uint? index, uint? totalIndex, TimeSpan? timeSpan)

CalcETAUnsafe(uint? index, uint? totalIndex, TimeSpan? timeSpan)

Returns null if any of parameter is null or returns estimated left time in milliseconds (double?)

• int?/uint? index: Current index of loop. Index must not be zero.

• int?/uint? totalIndex: Total index of loop.

• TimeSpan? timeSpan: Passed time of loop in TimeSpan format.

Multi-thread methods

⁴

CalcETA(int? totalIndex, long? totalElapsedTimeInMs)

CalcETAUnsafe(int? totalIndex, long? totalElapsedTimeInMs)

CalcETA(uint? totalIndex, long? totalElapsedTimeInMs)

CalcETAUnsafe(uint? totalIndex, long? TotalElapsedTimeInMs)

Returns null if any of parameter is null or returns estimated left time in milliseconds (long?)

• int?/uint? index: Current index of loop. Index must not be zero.

• long? totalElapsedTimeInMs: Passed time of loop in milliseconds.

⁵

CalcETA(int? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETAUnSafe(int? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETA(uint? totalIndex, long? totalElapsedTicks, long? frequency)

CalcETAUnsafe(uint? totalIndex, long? totalElapsedTicks, long? frequency)

Returns null if any of parameter is null or returns estimated left time in milliseconds (long?)

• int?/uint? index: Current index of loop. Index must not be zero.

• long? totalElapsedTicks: Passed ticks of loop.

• long? frequency: Tick of frequency. Frequency must not be zero.

⁶

CalcETA(int? totalIndex, TimeSpan? timeSpan)

CalcETAUnsafe(int? totalIndex, TimeSpan? timeSpan)

CalcETA(uint? totalIndex, TimeSpan? timeSpan)

CalcETAUnsafe(uint? totalIndex, TimeSpan? timeSpan)

Returns null if any of parameter is null or returns estimated left time in milliseconds (double?)

• int?/uint? index: Current index of loop. Index must not be zero.

• TimeSpan? timeSpan: Passed time of loop in TimeSpan format.

Visualization of output

TimeSpanETA(long? eTATimeInMs)

TimeSpanETAUnsafe(long eTATimeInMs)

Returns null if eTATimeInMs is null. Returns TimeSpan.Zero if etaTimeInMs is negative. Returns left time. Unsafe method returns left time directly on same format. (TimeSpan)

• long?: Estimated time to finish in milliseconds.

NumberFormatETA(long? eTATimeInMs)

NumberFormatETAUnsafe(long? eTATimeInMs)

Returns "Uncalculatable" if eTATimeInMs is null, returns "Negative" if eTATimeInMs is negative, returns left time in {hh:mm:ss:msms}. Unsafe method returns left time directly on same format. (string)

• long?: Estimated time to finish in milliseconds.

NameETA(long? eTATimeInMs)

NameETAUnsafe(long? eTATimeInMs)

Returns "Uncalculatable" if eTATimeInMs is null, returns "Negative" if eTATimeInMs is negative (string)

Returns {} second(s), {} minute(s) and {} second(s), {} hour(s) and {} minute(s), or {} day(s) and {} hour(s). Unsafe method returns left time directly on same format.

• long?: Estimated time to finish in milliseconds.

NameETABetterVisual(long? eTATimeInMs)

NameETABetterVisualUnsafe(long? eTATimeInMs)

Returns "Uncalculatable" if eTATimeInMs is null, returns "Negative" if eTATimeInMs is negative (string)

Returns {} second/seconds, {} minute/minutes and {} second/seconds, {} hour/hours and {} minute/minutes, or {} day/days and {} hour/hours. Unsafe method returns left time directly on same format.

• long?: Estimated time to finish in milliseconds.

Example Usage

public string MethodName(int? index, int? totalIndex, double? totalElapsedTimeInMs)
{
    return NameETA(CalcETA(index: index, totalIndex: totalIndex, totalElapsedTimeInMs: totalElapsedTimeInMs));
}

Single-Thread

• CalcETA¹(5, 10, 1000) ⇒ (long)1000
• CalcETA²(5, 20, 50000000, 10000000) ⇒ (long)15
• CalcETA³(5, 20, new TimeSpan(0, 0, 1, 5) ⇒ (double)195

Multi-Thread

• CalcETA⁴(10, 1000) ⇒ (long)1000
• CalcETA⁵(20, 50000000, 10000000) ⇒ (long)15
• CalcETA⁶(20, new TimeSpan(0, 0, 1, 5) ⇒ (double)195

Output

• TimeSpanETA(90000) ⇒ (TimeSpan)00:01:30
• NumberFormatETA(90000) ⇒ "0:1:30:0"
• NameETA(90000) ⇒ "1 minute(s) and 30 second(s)" (recommended for high-CPU-intense algorithm)
• NameETABetterVisual(90000) ⇒ "1 minute and 30 seconds"(recommended for low-CPU-intense algorithm in order to offer better visual output)

Version History

See commit change See release history See changelog

*1.6.2

• NumberFormatETA() and NumberFormatETAUnsafe() methods no longer return milliseconds as a part of return string.

• NumberFormatETA() now returns "Too long" if input parameter value causes calculations for more than a day.

• 1.6.1

  • Added missing return summaries.
  • Added warning for frequency parameter should be provided with ticksPerMilliseconds.
  • Fixed calculations on CalcETA(int, int timeSpan), CalcETA(uint,uint, timeSpan), CalcETAUnsafe(int, int, timeSpan) and CalcETAUnsafe(uint, uint, timeSpan).
  • Fixed wrong parameter name on methods that use totalElapsedTicks and frequency as parameters.

• 1.6.0

  • Added TimeSpanETAUnsafe(), NumberFormatETAUnsafe(), NameETAUnsafe() and NameETABetterVisualUnsafe() methods.
  • totalSeconds variables renamed into elapsedSeconds.
  • Additional checking is added for value check of index and frequency on available safe methods.

• 1.5.0

  • Added comments to every lines of code.

  • Added DivideByZeroException to methods when input parameter index is not longer being checkes for it was zero.

  • CalcETA() and CalcETAUnsafe() methods, now using nullable parameters.

  • CalcETA() methods checks if given parameters are null instead of 0 value.

  • CalcETA(..., long tickFrequency) method is now using CalcETA(..., long? frequency)

  • avarageElapsedTime varaiable is renamed into avarageElapsedTimeInMs.

  • seconds variable is renamed into elapsedSeconds.

  • TimeSpanETA() now returns null instead of TimeSpan.Zero when input parameter is null instead of it is zero value.

  • TimeSpanETA(), NumberFormatETA(), NameETA(), NameETABetterVisual() now uses new TimeSpan(ticks: ) instead of new TimeSpan(0,0,0,0, milliseconds: (int)eTATimeInMs)

  • NameETA() and NameETABetterVisual() are no longer returning result as $"{etaTimeInMs:0} ms" if input parameters is shorter then a second.

• 1.4.0

  • Added NameETABetterVisual() method for offer better visual output

• 1.3.0

  • Added support for uint data type as parameters.
  • Added unsafe methods for increase performance

• 1.2.1

  • Output folder is renamed as OutputDLL
  • Ready-to-use CalculateETA.dll and CalculateETA.xml are updated.

• 1.2.0

  • Fixed left time measurement bug.
  • When calculation left time TimeSpan is being used instead of conventional mathematical operations.

• 1.1.0

  • Added ResetCounter() method for reset counter that holds int variable to calculate ETA on multi-thread applications

• 1.0.0 Initial Release

Task list

Licence

No licence is required.

Authors

Twitter: Enes Okullu @enesokullu

Help

Twitter: Enes Okullu @enesokullu