Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readonly structs #3676

Merged
merged 3 commits into from
Jan 17, 2025
Merged

readonly structs #3676

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb4d2d8
readonly
shargon Jan 16, 2025
96211c3
Merge branch 'master' into readonly-bigdecimal
shargon Jan 17, 2025
9cc6687
Merge branch 'master' into readonly-bigdecimal
cschuchardt88 Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 40 additions & 38 deletions src/Neo/BigDecimal.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
// Redistribution and use in source and binary forms with or without
// modifications are permitted.

#nullable enable

using System;
using System.Numerics;

Expand All @@ -17,25 +19,25 @@ namespace Neo
/// <summary>
/// Represents a fixed-point number of arbitrary precision.
/// </summary>
public struct BigDecimal : IComparable<BigDecimal>, IEquatable<BigDecimal>
public readonly struct BigDecimal : IComparable<BigDecimal>, IEquatable<BigDecimal>
{
private readonly BigInteger value;
private readonly byte decimals;
private readonly BigInteger _value;
private readonly byte _decimals;

/// <summary>
/// The <see cref="BigInteger"/> value of the number.
/// </summary>
public readonly BigInteger Value => value;
public readonly BigInteger Value => _value;

/// <summary>
/// The number of decimal places for this number.
/// </summary>
public readonly byte Decimals => decimals;
public readonly byte Decimals => _decimals;

/// <summary>
/// The sign of the number.
/// </summary>
public readonly int Sign => value.Sign;
public readonly int Sign => _value.Sign;

/// <summary>
/// Initializes a new instance of the <see cref="BigDecimal"/> struct.
Expand All @@ -44,8 +46,8 @@ public struct BigDecimal : IComparable<BigDecimal>, IEquatable<BigDecimal>
/// <param name="decimals">The number of decimal places for this number.</param>
public BigDecimal(BigInteger value, byte decimals)
{
this.value = value;
this.decimals = decimals;
_value = value;
_decimals = decimals;
}

/// <summary>
Expand All @@ -59,9 +61,9 @@ public unsafe BigDecimal(decimal value)
fixed (int* p = span)
{
ReadOnlySpan<byte> buffer = new(p, 16);
this.value = new BigInteger(buffer[..12], isUnsigned: true);
if (buffer[15] != 0) this.value = -this.value;
decimals = buffer[14];
_value = new BigInteger(buffer[..12], isUnsigned: true);
if (buffer[15] != 0) _value = -_value;
_decimals = buffer[14];
}
}

Expand All @@ -77,15 +79,15 @@ public unsafe BigDecimal(decimal value, byte decimals)
fixed (int* p = span)
{
ReadOnlySpan<byte> buffer = new(p, 16);
this.value = new BigInteger(buffer[..12], isUnsigned: true);
_value = new BigInteger(buffer[..12], isUnsigned: true);
if (buffer[14] > decimals)
throw new ArgumentException(null, nameof(value));
else if (buffer[14] < decimals)
this.value *= BigInteger.Pow(10, decimals - buffer[14]);
_value *= BigInteger.Pow(10, decimals - buffer[14]);
if (buffer[15] != 0)
this.value = -this.value;
_value = -_value;
}
this.decimals = decimals;
_decimals = decimals;
}

/// <summary>
Expand All @@ -95,16 +97,16 @@ public unsafe BigDecimal(decimal value, byte decimals)
/// <returns>The <see cref="BigDecimal"/> that has the new number of decimal places.</returns>
public readonly BigDecimal ChangeDecimals(byte decimals)
{
if (this.decimals == decimals) return this;
if (_decimals == decimals) return this;
BigInteger value;
if (this.decimals < decimals)
if (_decimals < decimals)
{
value = this.value * BigInteger.Pow(10, decimals - this.decimals);
value = _value * BigInteger.Pow(10, decimals - _decimals);
}
else
{
BigInteger divisor = BigInteger.Pow(10, this.decimals - decimals);
value = BigInteger.DivRem(this.value, divisor, out BigInteger remainder);
var divisor = BigInteger.Pow(10, _decimals - decimals);
value = BigInteger.DivRem(_value, divisor, out var remainder);
if (remainder > BigInteger.Zero)
throw new ArgumentOutOfRangeException(nameof(decimals));
}
Expand All @@ -120,7 +122,7 @@ public readonly BigDecimal ChangeDecimals(byte decimals)
/// <exception cref="FormatException"><paramref name="s"/> is not in the correct format.</exception>
public static BigDecimal Parse(string s, byte decimals)
{
if (!TryParse(s, decimals, out BigDecimal result))
if (!TryParse(s, decimals, out var result))
throw new FormatException();
return result;
}
Expand All @@ -131,10 +133,10 @@ public static BigDecimal Parse(string s, byte decimals)
/// <returns>The <see cref="string"/> representing the number.</returns>
public override readonly string ToString()
{
BigInteger divisor = BigInteger.Pow(10, decimals);
BigInteger result = BigInteger.DivRem(value, divisor, out BigInteger remainder);
var divisor = BigInteger.Pow(10, _decimals);
var result = BigInteger.DivRem(_value, divisor, out var remainder);
if (remainder == 0) return result.ToString();
return $"{result}.{remainder.ToString("d" + decimals)}".TrimEnd('0');
return $"{result}.{remainder.ToString("d" + _decimals)}".TrimEnd('0');
}

/// <summary>
Expand All @@ -146,17 +148,17 @@ public override readonly string ToString()
/// <returns><see langword="true"/> if a number is successfully parsed; otherwise, <see langword="false"/>.</returns>
public static bool TryParse(string s, byte decimals, out BigDecimal result)
{
int e = 0;
int index = s.IndexOfAny(new[] { 'e', 'E' });
var e = 0;
var index = s.IndexOfAny(['e', 'E']);
if (index >= 0)
{
if (!sbyte.TryParse(s[(index + 1)..], out sbyte e_temp))
if (!sbyte.TryParse(s[(index + 1)..], out var e_temp))
{
result = default;
return false;
}
e = e_temp;
s = s.Substring(0, index);
s = s[..index];
}
index = s.IndexOf('.');
if (index >= 0)
Expand All @@ -165,15 +167,15 @@ public static bool TryParse(string s, byte decimals, out BigDecimal result)
e -= s.Length - index - 1;
s = s.Remove(index, 1);
}
int ds = e + decimals;
var ds = e + decimals;
if (ds < 0)
{
result = default;
return false;
}
if (ds > 0)
s += new string('0', ds);
if (!BigInteger.TryParse(s, out BigInteger value))
if (!BigInteger.TryParse(s, out var value))
{
result = default;
return false;
Expand All @@ -184,15 +186,15 @@ public static bool TryParse(string s, byte decimals, out BigDecimal result)

public readonly int CompareTo(BigDecimal other)
{
BigInteger left = value, right = other.value;
if (decimals < other.decimals)
left *= BigInteger.Pow(10, other.decimals - decimals);
else if (decimals > other.decimals)
right *= BigInteger.Pow(10, decimals - other.decimals);
BigInteger left = _value, right = other._value;
if (_decimals < other._decimals)
left *= BigInteger.Pow(10, other._decimals - _decimals);
else if (_decimals > other._decimals)
right *= BigInteger.Pow(10, _decimals - other._decimals);
return left.CompareTo(right);
}

public override readonly bool Equals(object obj)
public override readonly bool Equals(object? obj)
{
if (obj is not BigDecimal @decimal) return false;
return Equals(@decimal);
Expand All @@ -205,8 +207,8 @@ public readonly bool Equals(BigDecimal other)

public override readonly int GetHashCode()
{
BigInteger divisor = BigInteger.Pow(10, decimals);
BigInteger result = BigInteger.DivRem(value, divisor, out BigInteger remainder);
var divisor = BigInteger.Pow(10, _decimals);
var result = BigInteger.DivRem(_value, divisor, out var remainder);
return HashCode.Combine(result, remainder);
}

Expand Down
Loading