Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:core:ubench

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
scriptlog:lib:core:ubench [2026/09/26 09:09] – admin adminscriptlog:lib:core:ubench [2026/09/26 09:34] (current) – admin admin
Line 16: Line 16:
 //None.// //None.//
  
-======= Properties (0) =======+======= Properties (3) =======
  
-//None declared.//+^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
 +| ''protected'' | ''(untyped)'' | ''$start_time'' |  | 39 | 
 +| ''protected'' | ''(untyped)'' | ''$end_time'' |  | 41 | 
 +| ''protected'' | ''(untyped)'' | ''$memory_usage'' |  | 43 |
  
 ======= Methods (10) ======= ======= Methods (10) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''start()'' | Sets start microtime | 50 | +| public | ''start()'' | Sets start microtime | 50 | 
-  | public | ''end()'' | Sets end microtime | 61 | +| public | ''end()'' | Sets end microtime | 61 | 
-  | public | ''getTime()'' | Returns the elapsed time, readable or not | 80 | +| public | ''getTime()'' | Returns the elapsed time, readable or not | 80 | 
-  | public | ''getMemoryUsage()'' | Returns the memory usage at the end checkpoint | 102 | +| public | ''getMemoryUsage()'' | Returns the memory usage at the end checkpoint | 102 | 
-  | public | ''getMemoryPeak()'' | Returns the memory peak, readable or not | 114 | +| public | ''getMemoryPeak()'' | Returns the memory peak, readable or not | 114 | 
-  | public | ''run()'' | Wraps a callable with start() and end() calls | 130 | +| public | ''run()'' | Wraps a callable with start() and end() calls | 130 | 
-  | public static | ''readableSize()'' | Returns a human readable memory size | 150 | +| public static | ''readableSize()'' | Returns a human readable memory size | 150 | 
-  | public static | ''readableElapsedTime()'' | Returns a human readable elapsed time | 178 | +| public static | ''readableElapsedTime()'' | Returns a human readable elapsed time | 178 | 
-  | public | ''hasEnded()'' | (undocumented) | 198 | +| public | ''hasEnded()'' | (undocumented) | 198 | 
-  | public | ''hasStarted()'' | (undocumented) | 203 |+| public | ''hasStarted()'' | (undocumented) | 203 |
  
  
Line 77: Line 80:
 Returns the elapsed time, readable or not Returns the elapsed time, readable or not
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$raw'' | ''(untyped)'' | ''false'' | //none// | +|  ''$raw'' |  ''(untyped)'' |  ''false'' |  //none// | 
-  | ''$format'' | ''(untyped)'' | ''null'' | The format to display (printf format) |+|  ''$format'' |  ''(untyped)'' |  ''null'' |  The format to display (printf format) |
  
 **Returns:** ''(none declared)'' — float|string **Returns:** ''(none declared)'' — float|string
Line 96: Line 99:
 Returns the memory usage at the end checkpoint Returns the memory usage at the end checkpoint
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$raw'' | ''(untyped)'' | ''false'' | //none// | +|  ''$raw'' |  ''(untyped)'' |  ''false'' |  //none// | 
-  | ''$format'' | ''(untyped)'' | ''null'' | The format to display (printf format) |+|  ''$format'' |  ''(untyped)'' |  ''null'' |  The format to display (printf format) |
  
 **Returns:** ''(none declared)'' — string|float **Returns:** ''(none declared)'' — string|float
Line 113: Line 116:
 Returns the memory peak, readable or not Returns the memory peak, readable or not
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$raw'' | ''(untyped)'' | ''false'' | //none// | +|  ''$raw'' |  ''(untyped)'' |  ''false'' |  //none// | 
-  | ''$format'' | ''(untyped)'' | ''null'' | The format to display (printf format) |+|  ''$format'' |  ''(untyped)'' |  ''null'' |  The format to display (printf format) |
  
 **Returns:** ''(none declared)'' — string|float **Returns:** ''(none declared)'' — string|float
Line 133: Line 136:
 the callable. the callable.
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$callable'' | ''callable'' | //required// | //none// |+|  ''$callable'' |  ''callable'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — mixed **Returns:** ''(none declared)'' — mixed
Line 149: Line 152:
 Returns a human readable memory size Returns a human readable memory size
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$size'' | ''(untyped)'' | //required// | //none// | +|  ''$size'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$format'' | ''(untyped)'' | ''null'' | The format to display (printf format) | +|  ''$format'' |  ''(untyped)'' |  ''null'' |  The format to display (printf format) | 
-  | ''$round'' | ''(untyped)'' | ''3'' | //none// |+|  ''$round'' |  ''(untyped)'' |  ''3'' |  //none// |
  
 **Returns:** ''(none declared)'' — string **Returns:** ''(none declared)'' — string
Line 167: Line 170:
 Returns a human readable elapsed time Returns a human readable elapsed time
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$microtime'' | ''(untyped)'' | //required// | //none// | +|  ''$microtime'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$format'' | ''(untyped)'' | ''null'' | The format to display (printf format) | +|  ''$format'' |  ''(untyped)'' |  ''null'' |  The format to display (printf format) | 
-  | ''$round'' | ''(untyped)'' | ''3'' | //none// |+|  ''$round'' |  ''(untyped)'' |  ''3'' |  //none// |
  
 **Returns:** ''(none declared)'' — string **Returns:** ''(none declared)'' — string
scriptlog/lib/core/ubench.1790413762.txt.gz · Last modified: by admin