IncrementNumberRounder
IncrementNumberRounder
IncrementNumberRounder
IncrementNumberRounder
Class
Definition
Rounds numbers to a specified increment.
For example, this class can be used to round a number to the nearest 0.01.
public : sealed class IncrementNumberRounder : IIncrementNumberRounder, INumberRounderpublic sealed class IncrementNumberRounder : IIncrementNumberRounder, INumberRounderPublic NotInheritable Class IncrementNumberRounder Implements IIncrementNumberRounder, INumberRounder// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
IncrementNumberRounder() IncrementNumberRounder() IncrementNumberRounder() IncrementNumberRounder()
Creates an IncrementNumberRounder object.
This constructor initializes RoundingAlgorithm to a default value of RoundingAlgorithm.**RoundHalfUp**, and Increment to 1.
public : IncrementNumberRounder()public IncrementNumberRounder()Public Sub New()// You can use this method in JavaScript.
Properties
Increment Increment Increment Increment
Gets or sets the increment this IncrementNumberRounder object uses for rounding.
public : double Increment { get; set; }public double Increment { get; set; }Public ReadWrite Property Increment As double// You can use this property in JavaScript.
- Value
- double double double double
The increment used for rounding.
Remarks
This property can be one of the following:
- An integer greater than 0.
- A fraction of the form 1/n, where n is an integer between 2 and 10000000000, inclusive.
- 1.0e-11, 1.0e-12, 1.0e-13, 1.0e-14, 1.0e-15, 1.0e-16, 1.0e-17, 1.0e-18, 1.0e-19, or 1.0e-20.
This property is initialized to a default value of 1.
When rounding is performed, the result is produced in this manner:
- Divide the input by the Increment.
- Round the result to an integer using the rounding strategy of RoundingAlgorithm.
- Multiply the result by the Increment.
RoundingAlgorithm RoundingAlgorithm RoundingAlgorithm RoundingAlgorithm
Gets or sets the rounding strategy value for this IncrementNumberRounder object.
public : RoundingAlgorithm RoundingAlgorithm { get; set; }public RoundingAlgorithm RoundingAlgorithm { get; set; }Public ReadWrite Property RoundingAlgorithm As RoundingAlgorithm// You can use this property in JavaScript.
A value of the RoundingAlgorithm enumeration.
Remarks
This property is initialized to a default value of RoundingAlgorithm.**RoundHalfUp**.
Methods
RoundDouble(Double) RoundDouble(Double) RoundDouble(Double) RoundDouble(Double)
Rounds a Double number to the specified increment.
public : double RoundDouble(double value)public double RoundDouble(Double value)Public Function RoundDouble(value As Double) As double// You can use this method in JavaScript.
- value
- double Double Double Double
The Double value to be rounded.
The rounded number. This result is a double precision floating point number, which is not necessarily an integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.
Note
This method is precise only within the limits of the Double data type: approximately 15 digits.
RoundInt32(Int32) RoundInt32(Int32) RoundInt32(Int32) RoundInt32(Int32)
Rounds an Int32 number to the specified increment.
public : int RoundInt32(int value)public int RoundInt32(Int32 value)Public Function RoundInt32(value As Int32) As int// You can use this method in JavaScript.
- value
- int Int32 Int32 Int32
The Int32 value to be rounded.
The rounded 32 bit integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.
RoundInt64(Int64) RoundInt64(Int64) RoundInt64(Int64) RoundInt64(Int64)
Rounds an Int64 number to the specified increment.
public : long RoundInt64(long value)public long RoundInt64(Int64 value)Public Function RoundInt64(value As Int64) As long// You can use this method in JavaScript.
- value
- long Int64 Int64 Int64
The Int64 value to be rounded.
The rounded 64 bit integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.
RoundSingle(Single) RoundSingle(Single) RoundSingle(Single) RoundSingle(Single)
Rounds a Single number to the specified increment.
public : float RoundSingle(float value)public float RoundSingle(Single value)Public Function RoundSingle(value As Single) As float// You can use this method in JavaScript.
- value
- float Single Single Single
The Single value to be rounded.
The rounded number. This result is a single precision floating point number, which is not necessarily an integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.
Note
This method is precise only within the limits of the Single data type: approximately 7 digits.
RoundUInt32(UInt32) RoundUInt32(UInt32) RoundUInt32(UInt32) RoundUInt32(UInt32)
Rounds a UInt32 number to the specified increment.
public : unsigned int RoundUInt32(unsigned int value)public uint RoundUInt32(UInt32 value)Public Function RoundUInt32(value As UInt32) As uint// You can use this method in JavaScript.
- value
- unsigned int UInt32 UInt32 UInt32
The UInt32 value to be rounded.
The rounded unsigned 32 bit integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.
RoundUInt64(UInt64) RoundUInt64(UInt64) RoundUInt64(UInt64) RoundUInt64(UInt64)
Rounds a UInt64 number to the specified increment.
public : ulong RoundUInt64(unsigned __int64 value)public ulong RoundUInt64(UInt64 value)Public Function RoundUInt64(value As UInt64) As ulong// You can use this method in JavaScript.
- value
- unsigned __int64 UInt64 UInt64 UInt64
The UInt64 value to be rounded.
The rounded unsigned 64 bit integer.
Remarks
The rounding strategy is based on the values of Increment and RoundingAlgorithm.