blob: bec3bb94468a26a8f8ef8e48e139702b43ab81f2 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE
* file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
* to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.apache.tuweni.units.bigints;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import org.apache.tuweni.bytes.Bytes;
import java.math.BigInteger;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
// This test is in a `test` sub-package to ensure that it does not have access to package-private
// methods within the bigints package, as it should be testing the usage of the public API.
class BaseUInt256ValueTest {
private static class Value extends BaseUInt256Value<Value> {
static final Value MAX_VALUE = new Value(UInt256.MAX_VALUE);
Value(UInt256 v) {
super(v, Value::new);
}
Value(long v) {
super(v, Value::new);
}
Value(BigInteger s) {
super(s, Value::new);
}
}
private static Value v(long v) {
return new Value(v);
}
private static Value biv(String s) {
return new Value(new BigInteger(s));
}
private static Value hv(String s) {
return new Value(UInt256.fromHexString(s));
}
@ParameterizedTest
@MethodSource("addProvider")
void add(Value v1, Value v2, Value expected) {
assertValueEquals(expected, v1.add(v2));
}
private static Stream<Arguments> addProvider() {
return Stream.of(
Arguments.of(v(1), v(0), v(1)),
Arguments.of(v(5), v(0), v(5)),
Arguments.of(v(0), v(1), v(1)),
Arguments.of(v(0), v(100), v(100)),
Arguments.of(v(2), v(2), v(4)),
Arguments.of(v(100), v(90), v(190)),
Arguments.of(biv("13492324908428420834234908342"), v(10), biv("13492324908428420834234908352")),
Arguments.of(biv("13492324908428420834234908342"), v(23422141424214L), biv("13492324908428444256376332556")),
Arguments.of(Value.MAX_VALUE, v(1), v(0)),
Arguments.of(Value.MAX_VALUE, v(2), v(1)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0"),
v(1),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF1")),
Arguments.of(hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"), v(1), Value.MAX_VALUE));
}
@ParameterizedTest
@MethodSource("addUInt256Provider")
void addUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.add(v2));
}
private static Stream<Arguments> addUInt256Provider() {
return Stream.of(
Arguments.of(v(1), UInt256.ZERO, v(1)),
Arguments.of(v(5), UInt256.ZERO, v(5)),
Arguments.of(v(0), UInt256.ONE, v(1)),
Arguments.of(v(0), UInt256.valueOf(100), v(100)),
Arguments.of(v(2), UInt256.valueOf(2), v(4)),
Arguments.of(v(100), UInt256.valueOf(90), v(190)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(10), biv("13492324908428420834234908352")),
Arguments.of(
biv("13492324908428420834234908342"),
UInt256.valueOf(23422141424214L),
biv("13492324908428444256376332556")),
Arguments.of(Value.MAX_VALUE, UInt256.valueOf(1), v(0)),
Arguments.of(Value.MAX_VALUE, UInt256.valueOf(2), v(1)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0"),
UInt256.valueOf(1),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF1")),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
UInt256.valueOf(1),
Value.MAX_VALUE));
}
@ParameterizedTest
@MethodSource("addLongProvider")
void addLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.add(v2));
}
private static Stream<Arguments> addLongProvider() {
return Stream.of(
Arguments.of(v(1), 0L, v(1)),
Arguments.of(v(5), 0L, v(5)),
Arguments.of(v(0), 1L, v(1)),
Arguments.of(v(0), 100L, v(100)),
Arguments.of(v(2), 2L, v(4)),
Arguments.of(v(100), 90L, v(190)),
Arguments.of(biv("13492324908428420834234908342"), 10L, biv("13492324908428420834234908352")),
Arguments.of(biv("13492324908428420834234908342"), 23422141424214L, biv("13492324908428444256376332556")),
Arguments.of(Value.MAX_VALUE, 1L, v(0)),
Arguments.of(Value.MAX_VALUE, 2L, v(1)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0"),
1L,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF1")),
Arguments.of(hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"), 1L, Value.MAX_VALUE),
Arguments.of(v(10), -5L, v(5)),
Arguments.of(v(0), -1L, Value.MAX_VALUE));
}
@ParameterizedTest
@MethodSource("addModProvider")
void addMod(Value v1, Value v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.addMod(v2, m));
}
private static Stream<Arguments> addModProvider() {
return Stream.of(
Arguments.of(v(0), v(1), UInt256.valueOf(2), v(1)),
Arguments.of(v(1), v(1), UInt256.valueOf(2), v(0)),
Arguments.of(Value.MAX_VALUE.subtract(2), v(1), UInt256.MAX_VALUE, Value.MAX_VALUE.subtract(1)),
Arguments.of(Value.MAX_VALUE.subtract(1), v(1), UInt256.MAX_VALUE, v(0)),
Arguments.of(v(2), v(1), UInt256.valueOf(2), v(1)),
Arguments.of(v(3), v(2), UInt256.valueOf(6), v(5)),
Arguments.of(v(3), v(4), UInt256.valueOf(2), v(1)));
}
@Test
void shouldThrowForAddModOfZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).addMod(v(1), UInt256.ZERO));
assertEquals("addMod with zero modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("addModUInt256UInt256Provider")
void addModUInt256UInt256(Value v1, UInt256 v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.addMod(v2, m));
}
private static Stream<Arguments> addModUInt256UInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.ONE, UInt256.valueOf(2), v(1)),
Arguments.of(v(1), UInt256.ONE, UInt256.valueOf(2), v(0)),
Arguments.of(Value.MAX_VALUE.subtract(2), UInt256.ONE, UInt256.MAX_VALUE, Value.MAX_VALUE.subtract(1)),
Arguments.of(Value.MAX_VALUE.subtract(1), UInt256.ONE, UInt256.MAX_VALUE, v(0)),
Arguments.of(v(2), UInt256.ONE, UInt256.valueOf(2), v(1)),
Arguments.of(v(3), UInt256.valueOf(2), UInt256.valueOf(6), v(5)),
Arguments.of(v(3), UInt256.valueOf(4), UInt256.valueOf(2), v(1)));
}
@Test
void shouldThrowForAddModLongUInt256OfZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).addMod(1, UInt256.ZERO));
assertEquals("addMod with zero modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("addModLongUInt256Provider")
void addModLongUInt256(Value v1, long v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.addMod(v2, m));
}
private static Stream<Arguments> addModLongUInt256Provider() {
return Stream.of(
Arguments.of(v(0), 1L, UInt256.valueOf(2), v(1)),
Arguments.of(v(1), 1L, UInt256.valueOf(2), v(0)),
Arguments.of(Value.MAX_VALUE.subtract(2), 1L, UInt256.MAX_VALUE, Value.MAX_VALUE.subtract(1)),
Arguments.of(Value.MAX_VALUE.subtract(1), 1L, UInt256.MAX_VALUE, v(0)),
Arguments.of(v(2), 1L, UInt256.valueOf(2), v(1)),
Arguments.of(v(2), -1L, UInt256.valueOf(2), v(1)),
Arguments.of(v(1), -7L, UInt256.valueOf(5), v(4)));
}
@Test
void shouldThrowForAddModUInt256UInt256OfZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).addMod(UInt256.ONE, UInt256.ZERO));
assertEquals("addMod with zero modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("addModLongLongProvider")
void addModLongLong(Value v1, long v2, long m, Value expected) {
assertValueEquals(expected, v1.addMod(v2, m));
}
private static Stream<Arguments> addModLongLongProvider() {
return Stream
.of(Arguments.of(v(0), 1L, 2L, v(1)), Arguments.of(v(1), 1L, 2L, v(0)), Arguments.of(v(2), 1L, 2L, v(1)));
}
@Test
void shouldThrowForAddModLongLongOfZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).addMod(1, 0));
assertEquals("addMod with zero modulus", exception.getMessage());
}
@Test
void shouldThrowForAddModLongLongOfNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).addMod(1, -5));
assertEquals("addMod unsigned with negative modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("subtractProvider")
void subtract(Value v1, Value v2, Value expected) {
assertValueEquals(expected, v1.subtract(v2));
}
private static Stream<Arguments> subtractProvider() {
return Stream.of(
Arguments.of(v(1), v(0), v(1)),
Arguments.of(v(5), v(0), v(5)),
Arguments.of(v(2), v(1), v(1)),
Arguments.of(v(100), v(100), v(0)),
Arguments.of(biv("13492324908428420834234908342"), v(10), biv("13492324908428420834234908332")),
Arguments.of(biv("13492324908428420834234908342"), v(23422141424214L), biv("13492324908428397412093484128")),
Arguments.of(v(0), v(1), Value.MAX_VALUE),
Arguments.of(v(1), v(2), Value.MAX_VALUE),
Arguments.of(Value.MAX_VALUE, v(1), hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")));
}
@ParameterizedTest
@MethodSource("subtractUInt256Provider")
void subtractUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.subtract(v2));
}
private static Stream<Arguments> subtractUInt256Provider() {
return Stream.of(
Arguments.of(v(1), UInt256.ZERO, v(1)),
Arguments.of(v(5), UInt256.ZERO, v(5)),
Arguments.of(v(2), UInt256.ONE, v(1)),
Arguments.of(v(100), UInt256.valueOf(100), v(0)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(10), biv("13492324908428420834234908332")),
Arguments.of(
biv("13492324908428420834234908342"),
UInt256.valueOf(23422141424214L),
biv("13492324908428397412093484128")),
Arguments.of(v(0), UInt256.ONE, Value.MAX_VALUE),
Arguments.of(v(1), UInt256.valueOf(2), Value.MAX_VALUE),
Arguments.of(
Value.MAX_VALUE,
UInt256.ONE,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")));
}
@ParameterizedTest
@MethodSource("subtractLongProvider")
void subtractLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.subtract(v2));
}
private static Stream<Arguments> subtractLongProvider() {
return Stream.of(
Arguments.of(v(1), 0L, v(1)),
Arguments.of(v(5), 0L, v(5)),
Arguments.of(v(2), 1L, v(1)),
Arguments.of(v(100), 100L, v(0)),
Arguments.of(biv("13492324908428420834234908342"), 10L, biv("13492324908428420834234908332")),
Arguments.of(biv("13492324908428420834234908342"), 23422141424214L, biv("13492324908428397412093484128")),
Arguments.of(v(0), 1L, Value.MAX_VALUE),
Arguments.of(v(1), 2L, Value.MAX_VALUE),
Arguments.of(Value.MAX_VALUE, 1L, hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")),
Arguments.of(v(0), -1L, v(1)),
Arguments.of(v(0), -100L, v(100)),
Arguments.of(v(2), -2L, v(4)));
}
@ParameterizedTest
@MethodSource("multiplyProvider")
void multiply(Value v1, Value v2, Value expected) {
assertValueEquals(expected, v1.multiply(v2));
}
private static Stream<Arguments> multiplyProvider() {
return Stream.of(
Arguments.of(v(0), v(1), v(0)),
Arguments.of(v(1), v(0), v(0)),
Arguments.of(v(1), v(20), v(20)),
Arguments.of(v(20), v(1), v(20)),
Arguments.of(hv("0x0a0000000000"), v(1), hv("0x0a0000000000")),
Arguments.of(v(1), hv("0x0a0000000000"), hv("0x0a0000000000")),
Arguments.of(v(0), v(2), v(0)),
Arguments.of(v(1), v(2), v(2)),
Arguments.of(v(2), v(2), v(4)),
Arguments.of(v(3), v(2), v(6)),
Arguments.of(v(4), v(2), v(8)),
Arguments.of(v(10), v(18), v(180)),
Arguments.of(biv("13492324908428420834234908341"), v(2), biv("26984649816856841668469816682")),
Arguments.of(biv("13492324908428420834234908342"), v(2), biv("26984649816856841668469816684")),
Arguments.of(v(2), v(8), v(16)),
Arguments.of(v(7), v(8), v(56)),
Arguments.of(v(8), v(8), v(64)),
Arguments.of(v(17), v(8), v(136)),
Arguments.of(biv("13492324908428420834234908342"), v(8), biv("107938599267427366673879266736")),
Arguments.of(biv("13492324908428420834234908342"), v(2048), biv("27632281412461405868513092284416")),
Arguments.of(biv("13492324908428420834234908342"), v(131072), biv("1768466010397529975584837906202624")),
Arguments.of(v(22), v(0), v(0)));
}
@ParameterizedTest
@MethodSource("multiplyUInt256Provider")
void multiplyUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.multiply(v2));
}
private static Stream<Arguments> multiplyUInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.valueOf(1), v(0)),
Arguments.of(v(1), UInt256.valueOf(0), v(0)),
Arguments.of(v(1), UInt256.valueOf(20), v(20)),
Arguments.of(v(20), UInt256.valueOf(1), v(20)),
Arguments.of(hv("0x0a0000000000"), UInt256.valueOf(1), hv("0x0a0000000000")),
Arguments.of(v(1), UInt256.fromHexString("0x0a0000000000"), hv("0x0a0000000000")),
Arguments.of(v(0), UInt256.valueOf(2), v(0)),
Arguments.of(v(1), UInt256.valueOf(2), v(2)),
Arguments.of(v(2), UInt256.valueOf(2), v(4)),
Arguments.of(v(3), UInt256.valueOf(2), v(6)),
Arguments.of(v(4), UInt256.valueOf(2), v(8)),
Arguments.of(v(10), UInt256.valueOf(18), v(180)),
Arguments.of(biv("13492324908428420834234908341"), UInt256.valueOf(2), biv("26984649816856841668469816682")),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(2), biv("26984649816856841668469816684")),
Arguments.of(v(2), UInt256.valueOf(8), v(16)),
Arguments.of(v(7), UInt256.valueOf(8), v(56)),
Arguments.of(v(8), UInt256.valueOf(8), v(64)),
Arguments.of(v(17), UInt256.valueOf(8), v(136)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(8), biv("107938599267427366673879266736")),
Arguments
.of(biv("13492324908428420834234908342"), UInt256.valueOf(2048), biv("27632281412461405868513092284416")),
Arguments.of(
biv("13492324908428420834234908342"),
UInt256.valueOf(131072),
biv("1768466010397529975584837906202624")),
Arguments.of(v(22), UInt256.ZERO, v(0)),
Arguments.of(
hv("0x0FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
UInt256.valueOf(2),
hv("0x1FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
UInt256.valueOf(2),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")));
}
@ParameterizedTest
@MethodSource("multiplyLongProvider")
void multiplyLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.multiply(v2));
}
private static Stream<Arguments> multiplyLongProvider() {
return Stream.of(
Arguments.of(v(0), 1L, v(0)),
Arguments.of(v(1), 0L, v(0)),
Arguments.of(v(1), 20L, v(20)),
Arguments.of(v(20), 1L, v(20)),
Arguments.of(hv("0x0a0000000000"), 1L, hv("0x0a0000000000")),
Arguments.of(v(1), 10995116277760L, hv("0x0a0000000000")),
Arguments.of(v(0), 2L, v(0)),
Arguments.of(v(1), 2L, v(2)),
Arguments.of(v(2), 2L, v(4)),
Arguments.of(v(3), 2L, v(6)),
Arguments.of(v(4), 2L, v(8)),
Arguments.of(v(10), 18L, v(180)),
Arguments.of(biv("13492324908428420834234908341"), 2L, biv("26984649816856841668469816682")),
Arguments.of(biv("13492324908428420834234908342"), 2L, biv("26984649816856841668469816684")),
Arguments.of(v(2), 8L, v(16)),
Arguments.of(v(7), 8L, v(56)),
Arguments.of(v(8), 8L, v(64)),
Arguments.of(v(17), 8L, v(136)),
Arguments.of(biv("13492324908428420834234908342"), 8L, biv("107938599267427366673879266736")),
Arguments.of(biv("13492324908428420834234908342"), 2048L, biv("27632281412461405868513092284416")),
Arguments.of(biv("13492324908428420834234908342"), 131072L, biv("1768466010397529975584837906202624")),
Arguments.of(v(22), 0L, v(0)),
Arguments.of(
hv("0x0FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
2L,
hv("0x1FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
2L,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE")));
}
@Test
void shouldThrowForMultiplyLongOfNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(2).multiply(-5));
assertEquals("multiply unsigned by negative", exception.getMessage());
}
@ParameterizedTest
@MethodSource("multiplyModProvider")
void multiplyMod(Value v1, Value v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.multiplyMod(v2, m));
}
private static Stream<Arguments> multiplyModProvider() {
return Stream.of(
Arguments.of(v(0), v(5), UInt256.valueOf(2), v(0)),
Arguments.of(v(2), v(3), UInt256.valueOf(7), v(6)),
Arguments.of(v(2), v(3), UInt256.valueOf(6), v(0)),
Arguments.of(v(2), v(0), UInt256.valueOf(6), v(0)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
v(2),
UInt256.MAX_VALUE,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD")));
}
@Test
void shouldThrowForMultiplyModOfModZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(0).multiplyMod(v(1), UInt256.ZERO));
assertEquals("multiplyMod with zero modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("multiplyModUInt256UInt256Provider")
void multiplyModUInt256UInt256(Value v1, UInt256 v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.multiplyMod(v2, m));
}
private static Stream<Arguments> multiplyModUInt256UInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.valueOf(5), UInt256.valueOf(2), v(0)),
Arguments.of(v(2), UInt256.valueOf(3), UInt256.valueOf(7), v(6)),
Arguments.of(v(2), UInt256.valueOf(3), UInt256.valueOf(6), v(0)),
Arguments.of(v(2), UInt256.ZERO, UInt256.valueOf(6), v(0)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
UInt256.valueOf(2),
UInt256.MAX_VALUE,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD")));
}
@Test
void shouldThrowForMultiplyModUInt256UInt256OfModZero() {
Throwable exception =
assertThrows(ArithmeticException.class, () -> v(0).multiplyMod(UInt256.valueOf(5), UInt256.ZERO));
assertEquals("multiplyMod with zero modulus", exception.getMessage());
}
@ParameterizedTest
@MethodSource("multiplyModLongUInt256Provider")
void multiplyModLongUInt256(Value v1, long v2, UInt256 m, Value expected) {
assertValueEquals(expected, v1.multiplyMod(v2, m));
}
private static Stream<Arguments> multiplyModLongUInt256Provider() {
return Stream.of(
Arguments.of(v(0), 5L, UInt256.valueOf(2), v(0)),
Arguments.of(v(2), 3L, UInt256.valueOf(7), v(6)),
Arguments.of(v(2), 3L, UInt256.valueOf(6), v(0)),
Arguments.of(v(2), 0L, UInt256.valueOf(6), v(0)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
2L,
UInt256.MAX_VALUE,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD")));
}
@Test
void shouldThrowForMultiplyModLongUInt256OfModZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(3).multiplyMod(1L, UInt256.ZERO));
assertEquals("multiplyMod with zero modulus", exception.getMessage());
}
@Test
void shouldThrowForMultiplyModLongUInt256OfNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).multiplyMod(-1, UInt256.valueOf(2)));
assertEquals("multiplyMod unsigned by negative", exception.getMessage());
}
@ParameterizedTest
@MethodSource("multiplyModLongLongProvider")
void multiplyModLongLong(Value v1, long v2, long m, Value expected) {
assertValueEquals(expected, v1.multiplyMod(v2, m));
}
private static Stream<Arguments> multiplyModLongLongProvider() {
return Stream.of(
Arguments.of(v(0), 5L, 2L, v(0)),
Arguments.of(v(2), 3L, 7L, v(6)),
Arguments.of(v(2), 3L, 6L, v(0)),
Arguments.of(v(2), 0L, 6L, v(0)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
2L,
Long.MAX_VALUE,
hv("0x000000000000000000000000000000000000000000000000000000000000001C")));
}
@Test
void shouldThrowForMultiplyModLongLongOfModZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).multiplyMod(1, 0));
assertEquals("multiplyMod with zero modulus", exception.getMessage());
}
@Test
void shouldThrowForMultiplyModLongLongOfModNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(2).multiplyMod(5, -7));
assertEquals("multiplyMod unsigned with negative modulus", exception.getMessage());
}
@Test
void shouldThrowForMultiplyModLongLongOfNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(3).multiplyMod(-1, 2));
assertEquals("multiplyMod unsigned by negative", exception.getMessage());
}
@ParameterizedTest
@MethodSource("divideProvider")
void divide(Value v1, Value v2, Value expected) {
assertValueEquals(expected, v1.divide(v2));
}
private static Stream<Arguments> divideProvider() {
return Stream.of(
Arguments.of(v(0), v(2), v(0)),
Arguments.of(v(1), v(2), v(0)),
Arguments.of(v(2), v(2), v(1)),
Arguments.of(v(3), v(2), v(1)),
Arguments.of(v(4), v(2), v(2)),
Arguments.of(biv("13492324908428420834234908341"), v(2), biv("6746162454214210417117454170")),
Arguments.of(biv("13492324908428420834234908342"), v(2), biv("6746162454214210417117454171")),
Arguments.of(biv("13492324908428420834234908343"), v(2), biv("6746162454214210417117454171")),
Arguments.of(v(2), v(8), v(0)),
Arguments.of(v(7), v(8), v(0)),
Arguments.of(v(8), v(8), v(1)),
Arguments.of(v(9), v(8), v(1)),
Arguments.of(v(17), v(8), v(2)),
Arguments.of(v(1024), v(8), v(128)),
Arguments.of(v(1026), v(8), v(128)),
Arguments.of(biv("13492324908428420834234908342"), v(8), biv("1686540613553552604279363542")),
Arguments.of(biv("13492324908428420834234908342"), v(2048), biv("6588049271693564860466263")),
Arguments.of(biv("13492324908428420834234908342"), v(131072), biv("102938269870211950944785")));
}
@Test
void shouldThrowForDivideByZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).divide(v(0)));
assertEquals("divide by zero", exception.getMessage());
}
@ParameterizedTest
@MethodSource("divideUInt256Provider")
void divideUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.divide(v2));
}
private static Stream<Arguments> divideUInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.valueOf(2), v(0)),
Arguments.of(v(1), UInt256.valueOf(2), v(0)),
Arguments.of(v(2), UInt256.valueOf(2), v(1)),
Arguments.of(v(3), UInt256.valueOf(2), v(1)),
Arguments.of(v(4), UInt256.valueOf(2), v(2)),
Arguments.of(biv("13492324908428420834234908341"), UInt256.valueOf(2), biv("6746162454214210417117454170")),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(2), biv("6746162454214210417117454171")),
Arguments.of(biv("13492324908428420834234908343"), UInt256.valueOf(2), biv("6746162454214210417117454171")),
Arguments.of(v(2), UInt256.valueOf(8), v(0)),
Arguments.of(v(7), UInt256.valueOf(8), v(0)),
Arguments.of(v(8), UInt256.valueOf(8), v(1)),
Arguments.of(v(9), UInt256.valueOf(8), v(1)),
Arguments.of(v(17), UInt256.valueOf(8), v(2)),
Arguments.of(v(1024), UInt256.valueOf(8), v(128)),
Arguments.of(v(1026), UInt256.valueOf(8), v(128)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(8), biv("1686540613553552604279363542")),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(2048), biv("6588049271693564860466263")),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(131072), biv("102938269870211950944785")));
}
@Test
void shouldThrowForDivideUInt256ByZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).divide(UInt256.ZERO));
assertEquals("divide by zero", exception.getMessage());
}
@ParameterizedTest
@MethodSource("divideLongProvider")
void divideLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.divide(v2));
}
private static Stream<Arguments> divideLongProvider() {
return Stream.of(
Arguments.of(v(0), 2L, v(0)),
Arguments.of(v(1), 2L, v(0)),
Arguments.of(v(2), 2L, v(1)),
Arguments.of(v(3), 2L, v(1)),
Arguments.of(v(4), 2L, v(2)),
Arguments.of(biv("13492324908428420834234908341"), 2L, biv("6746162454214210417117454170")),
Arguments.of(biv("13492324908428420834234908342"), 2L, biv("6746162454214210417117454171")),
Arguments.of(biv("13492324908428420834234908343"), 2L, biv("6746162454214210417117454171")),
Arguments.of(v(2), 8L, v(0)),
Arguments.of(v(7), 8L, v(0)),
Arguments.of(v(8), 8L, v(1)),
Arguments.of(v(9), 8L, v(1)),
Arguments.of(v(17), 8L, v(2)),
Arguments.of(v(1024), 8L, v(128)),
Arguments.of(v(1026), 8L, v(128)),
Arguments.of(biv("13492324908428420834234908342"), 8L, biv("1686540613553552604279363542")),
Arguments.of(biv("13492324908428420834234908342"), 2048L, biv("6588049271693564860466263")),
Arguments.of(biv("13492324908428420834234908342"), 131072L, biv("102938269870211950944785")));
}
@Test
void shouldThrowForDivideLongByZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).divide(0));
assertEquals("divide by zero", exception.getMessage());
}
@Test
void shouldThrowForDivideLongByNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).divide(-5));
assertEquals("divide unsigned by negative", exception.getMessage());
}
@ParameterizedTest
@MethodSource("powUInt256Provider")
void powUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.pow(v2));
}
private static Stream<Arguments> powUInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.valueOf(2), v(0)),
Arguments.of(v(2), UInt256.valueOf(2), v(4)),
Arguments.of(v(2), UInt256.valueOf(8), v(256)),
Arguments.of(v(3), UInt256.valueOf(3), v(27)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0F0F0"),
UInt256.valueOf(3),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF2A920E119A2F000")));
}
@ParameterizedTest
@MethodSource("powLongProvider")
void powLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.pow(v2));
}
private static Stream<Arguments> powLongProvider() {
return Stream.of(
Arguments.of(v(0), 2L, v(0)),
Arguments.of(v(2), 2L, v(4)),
Arguments.of(v(2), 8L, v(256)),
Arguments.of(v(3), 3L, v(27)),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0F0F0"),
3L,
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF2A920E119A2F000")),
Arguments.of(v(3), -3L, hv("0x2F684BDA12F684BDA12F684BDA12F684BDA12F684BDA12F684BDA12F684BDA13")));
}
@ParameterizedTest
@MethodSource("modUInt256Provider")
void modUInt256(Value v1, UInt256 v2, Value expected) {
assertValueEquals(expected, v1.mod(v2));
}
private static Stream<Arguments> modUInt256Provider() {
return Stream.of(
Arguments.of(v(0), UInt256.valueOf(2), v(0)),
Arguments.of(v(1), UInt256.valueOf(2), v(1)),
Arguments.of(v(2), UInt256.valueOf(2), v(0)),
Arguments.of(v(3), UInt256.valueOf(2), v(1)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(2), v(0)),
Arguments.of(biv("13492324908428420834234908343"), UInt256.valueOf(2), v(1)),
Arguments.of(v(0), UInt256.valueOf(8), v(0)),
Arguments.of(v(1), UInt256.valueOf(8), v(1)),
Arguments.of(v(2), UInt256.valueOf(8), v(2)),
Arguments.of(v(3), UInt256.valueOf(8), v(3)),
Arguments.of(v(7), UInt256.valueOf(8), v(7)),
Arguments.of(v(8), UInt256.valueOf(8), v(0)),
Arguments.of(v(9), UInt256.valueOf(8), v(1)),
Arguments.of(v(1024), UInt256.valueOf(8), v(0)),
Arguments.of(v(1026), UInt256.valueOf(8), v(2)),
Arguments.of(biv("13492324908428420834234908342"), UInt256.valueOf(8), v(6)),
Arguments.of(biv("13492324908428420834234908343"), UInt256.valueOf(8), v(7)),
Arguments.of(biv("13492324908428420834234908344"), UInt256.valueOf(8), v(0)));
}
@Test
void shouldThrowForModUInt256ByZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).mod(UInt256.ZERO));
assertEquals("mod by zero", exception.getMessage());
}
@ParameterizedTest
@MethodSource("modLongProvider")
void modLong(Value v1, long v2, Value expected) {
assertValueEquals(expected, v1.mod(v2));
}
private static Stream<Arguments> modLongProvider() {
return Stream.of(
Arguments.of(v(0), 2L, v(0)),
Arguments.of(v(1), 2L, v(1)),
Arguments.of(v(2), 2L, v(0)),
Arguments.of(v(3), 2L, v(1)),
Arguments.of(biv("13492324908428420834234908342"), 2L, v(0)),
Arguments.of(biv("13492324908428420834234908343"), 2L, v(1)),
Arguments.of(v(0), 8L, v(0)),
Arguments.of(v(1), 8L, v(1)),
Arguments.of(v(2), 8L, v(2)),
Arguments.of(v(3), 8L, v(3)),
Arguments.of(v(7), 8L, v(7)),
Arguments.of(v(8), 8L, v(0)),
Arguments.of(v(9), 8L, v(1)),
Arguments.of(v(1024), 8L, v(0)),
Arguments.of(v(1026), 8L, v(2)),
Arguments.of(biv("13492324908428420834234908342"), 8L, v(6)),
Arguments.of(biv("13492324908428420834234908343"), 8L, v(7)),
Arguments.of(biv("13492324908428420834234908344"), 8L, v(0)));
}
@Test
void shouldThrowForModLongByZero() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).mod(0));
assertEquals("mod by zero", exception.getMessage());
}
@Test
void shouldReturnZeroForMod0LongByZero() {
assertEquals(UInt256.ZERO, v(5).mod0(0).toUInt256());
}
@Test
void shouldThrowForModLongByNegative() {
Throwable exception = assertThrows(ArithmeticException.class, () -> v(5).mod(-5));
assertEquals("mod by negative", exception.getMessage());
}
@ParameterizedTest
@MethodSource("compareToProvider")
void compareTo(Value v1, Value v2, int expected) {
assertEquals(expected, v1.compareTo(v2));
}
private static Stream<Arguments> compareToProvider() {
return Stream.of(
Arguments.of(v(5), v(5), 0),
Arguments.of(v(5), v(3), 1),
Arguments.of(v(5), v(6), -1),
Arguments.of(
hv("0x0000000000000000000000000000000000000000000000000000000000000000"),
hv("0x0000000000000000000000000000000000000000000000000000000000000000"),
0),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
0),
Arguments.of(
hv("0x000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
hv("0x000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
0),
Arguments.of(
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
hv("0x0000000000000000000000000000000000000000000000000000000000000000"),
1),
Arguments.of(
hv("0x0000000000000000000000000000000000000000000000000000000000000000"),
hv("0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
-1),
Arguments.of(
hv("0x000000000000000000000000000001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
hv("0x000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
1),
Arguments.of(
hv("0x000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE"),
hv("0x000000000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"),
-1));
}
@ParameterizedTest
@MethodSource("toBytesProvider")
void toBytesTest(Value value, Bytes expected) {
assertEquals(expected, value.toBytes());
}
private static Stream<Arguments> toBytesProvider() {
return Stream.of(
Arguments
.of(hv("0x00"), Bytes.fromHexString("0x0000000000000000000000000000000000000000000000000000000000000000")),
Arguments.of(
hv("0x01000000"),
Bytes.fromHexString("0x0000000000000000000000000000000000000000000000000000000001000000")),
Arguments.of(
hv("0x0100000000"),
Bytes.fromHexString("0x0000000000000000000000000000000000000000000000000000000100000000")),
Arguments.of(
hv("0xf100000000ab"),
Bytes.fromHexString("0x0000000000000000000000000000000000000000000000000000f100000000ab")),
Arguments.of(
hv("0x0400000000000000000000000000000000000000000000000000f100000000ab"),
Bytes.fromHexString("0x0400000000000000000000000000000000000000000000000000f100000000ab")));
}
@ParameterizedTest
@MethodSource("toMinimalBytesProvider")
void toMinimalBytesTest(Value value, Bytes expected) {
assertEquals(expected, value.toMinimalBytes());
}
private static Stream<Arguments> toMinimalBytesProvider() {
return Stream.of(
Arguments.of(hv("0x00"), Bytes.EMPTY),
Arguments.of(hv("0x01000000"), Bytes.fromHexString("0x01000000")),
Arguments.of(hv("0x0100000000"), Bytes.fromHexString("0x0100000000")),
Arguments.of(hv("0xf100000000ab"), Bytes.fromHexString("0xf100000000ab")),
Arguments.of(
hv("0x0400000000000000000000000000000000000000000000000000f100000000ab"),
Bytes.fromHexString("0x0400000000000000000000000000000000000000000000000000f100000000ab")));
}
@ParameterizedTest
@MethodSource("numberOfLeadingZerosProvider")
void numberOfLeadingZeros(Value value, int expected) {
assertEquals(expected, value.numberOfLeadingZeros());
}
private static Stream<Arguments> numberOfLeadingZerosProvider() {
return Stream.of(
Arguments.of(hv("0x00"), 256),
Arguments.of(hv("0x01"), 255),
Arguments.of(hv("0x02"), 254),
Arguments.of(hv("0x03"), 254),
Arguments.of(hv("0x0F"), 252),
Arguments.of(hv("0x8F"), 248),
Arguments.of(hv("0x100000000"), 223));
}
@ParameterizedTest
@MethodSource("bitLengthProvider")
void bitLength(Value value, int expected) {
assertEquals(expected, value.bitLength());
}
private static Stream<Arguments> bitLengthProvider() {
return Stream.of(
Arguments.of(hv("0x00"), 0),
Arguments.of(hv("0x01"), 1),
Arguments.of(hv("0x02"), 2),
Arguments.of(hv("0x03"), 2),
Arguments.of(hv("0x0F"), 4),
Arguments.of(hv("0x8F"), 8),
Arguments.of(hv("0x100000000"), 33));
}
@ParameterizedTest
@MethodSource("addExactProvider")
void addExact(Value value, Value operand) {
assertThrows(ArithmeticException.class, () -> value.addExact(operand));
}
private static Stream<Arguments> addExactProvider() {
return Stream.of(Arguments.of(Value.MAX_VALUE, v(1)), Arguments.of(Value.MAX_VALUE, Value.MAX_VALUE));
}
@ParameterizedTest
@MethodSource("addExactLongProvider")
void addExactLong(Value value, long operand) {
assertThrows(ArithmeticException.class, () -> value.addExact(operand));
}
private static Stream<Arguments> addExactLongProvider() {
return Stream
.of(Arguments.of(Value.MAX_VALUE, 3), Arguments.of(Value.MAX_VALUE, Long.MAX_VALUE), Arguments.of(v(0), -1));
}
@ParameterizedTest
@MethodSource("subtractExactProvider")
void subtractExact(Value value, Value operand) {
assertThrows(ArithmeticException.class, () -> value.subtractExact(operand));
}
private static Stream<Arguments> subtractExactProvider() {
return Stream.of(Arguments.of(v(0), v(1)), Arguments.of(v(0), Value.MAX_VALUE));
}
@ParameterizedTest
@MethodSource("subtractExactLongProvider")
void subtractExactLong(Value value, long operand) {
assertThrows(ArithmeticException.class, () -> value.subtractExact(operand));
}
private static Stream<Arguments> subtractExactLongProvider() {
return Stream.of(Arguments.of(v(0), 1), Arguments.of(v(0), Long.MAX_VALUE), Arguments.of(Value.MAX_VALUE, -1));
}
private void assertValueEquals(Value expected, Value actual) {
String msg = String.format("Expected %s but got %s", expected.toHexString(), actual.toHexString());
assertEquals(expected, actual, msg);
}
}