Stay organized with collections
Save and categorize content based on your preferences.
C++ Reference: class IncrementalAverage
Note: This documentation is automatically generated.
Manages incremental averages.
| Method |
AddData | Return type: void Arguments: double new_record |
CurrentAverage | Return type: double |
IncrementalAverage | Return type: explicit Arguments: double initial_average Initializes the average with 'initial_average' and number of records to 0.
|
IncrementalAverage | |
NumRecords | Return type: int64_t |
Reset | Return type: void Arguments: double reset_value Sets the number of records to 0 and average to 'reset_value'.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eIncrementalAverage\u003c/code\u003e class in C++ facilitates the calculation and management of running averages.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to add new data points (\u003ccode\u003eAddData\u003c/code\u003e), retrieve the current average (\u003ccode\u003eCurrentAverage\u003c/code\u003e), and access the total number of records (\u003ccode\u003eNumRecords\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eUsers can initialize the average with a starting value or reset it to a specific value using dedicated methods (\u003ccode\u003eIncrementalAverage\u003c/code\u003e, \u003ccode\u003eReset\u003c/code\u003e).\u003c/p\u003e\n"]]],["The `IncrementalAverage` class in C++ manages running averages. Key actions include initializing the average with a given value, adding new data points via `AddData`, retrieving the current average with `CurrentAverage`, and obtaining the number of records using `NumRecords`. The `Reset` method allows resetting the average and the record count to zero. There is also a method to construct the class with an initial average value.\n"],null,["# IncrementalAverage\n\nC++ Reference: class IncrementalAverage\n=======================================\n\n\nNote: This documentation is automatically generated.\nManages incremental averages.\n\n| Method ||\n|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| [`AddData`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L278) | Return type: `void ` Arguments: `double new_record` \u003cbr /\u003e |\n| [`CurrentAverage`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L275) | Return type: `double ` \u003cbr /\u003e |\n| [`IncrementalAverage`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L268) | Return type: `explicit ` Arguments: `double initial_average` Initializes the average with 'initial_average' and number of records to 0. |\n| [`IncrementalAverage`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L270) | \u003cbr /\u003e |\n| [`NumRecords`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L276) | Return type: `int64_t ` \u003cbr /\u003e |\n| [`Reset`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/util.h#L273) | Return type: `void ` Arguments: `double reset_value` Sets the number of records to 0 and average to 'reset_value'. |"]]
