Module org.zfcj.math.concretenumbers

Package org.zfcj.math.numbers

Interface PositiveInteger

All Superinterfaces:

CardinalNumber, Comparable<RealNumber>, CountableNumber, Integer, NaturalNumber, Number, RationalNumber, RealNumber

All Known Subinterfaces:

AtLeastEight, AtLeastEighteen, AtLeastEleven, AtLeastFifteen, AtLeastFive, AtLeastFour, AtLeastFourteen, AtLeastNine, AtLeastNineteen, AtLeastOne, AtLeastSeven, AtLeastSeventeen, AtLeastSix, AtLeastSixteen, AtLeastTen, AtLeastThirteen, AtLeastThree, AtLeastTwelve, AtLeastTwenty, AtLeastTwo, FourOrEight

All Known Implementing Classes:

Eight, Eighteen, Eleven, Fifteen, Five, Four, Fourteen, Nine, Nineteen, One, Seven, Seventeen, Six, Sixteen, Ten, Thirteen, Three, Twelve, Twenty, Two

public interface PositiveInteger
extends NaturalNumber

A PositiveInteger is a NaturalNumber that isn't Zero.

Field Summary

Fields

Modifier and Type	Field	Description
static final PositiveInteger	MAX_INT

Method Summary

Modifier and Type	Method	Description
default Stream<PositiveInteger>	count1ToN()	Returns a Stream of all PositiveIntegers in the range from One to this PositiveInteger
default Stream<PositiveInteger>	count1ToNMinus1()	Returns a Stream of all PositiveIntegers in the range from One to this PositiveInteger minus 1
default Stream<NaturalNumber>	countNMinus1To0()	Returns a Stream of all NaturalNumbers in the range from this NaturalNumber minus 1 to Zero
default Stream<PositiveInteger>	countTo(PositiveInteger i)	Returns a Stream of all PositiveIntegers in the range from this PositiveInteger to the given PositiveInteger
default PositiveInteger	divide(PositiveInteger n)	Returns the quotient of dividing this PositiveInteger by the given PositiveInteger
default NaturalNumber	minusOne()	Returns the NaturalNumber that is one less than this PositiveInteger
static PositiveInteger	of(int i)	Creates a new PositiveInteger whose value is the given int
static PositiveInteger	of(long l)	Creates a new PositiveInteger whose value is the given long
static PositiveInteger	of(BigInteger bi)	Creates a new PositiveInteger whose value is the given BigInteger
static PositiveInteger	parse(String s)	Creates a new PositiveInteger from the given string or throws an Exception if the string does not represent a PositiveInteger.
default PositiveInteger	plus(PositiveInteger n)	Returns the sum of this PositiveInteger and the given PositiveInteger
default PositiveInteger	times(PositiveInteger n)	Returns the product of this PositiveInteger and the given PositiveInteger

Methods inherited from interface org.zfcj.math.numbers.Integer

bigIntegerValue, compareTo, countTo, denominator, divide, doubleValue, greaterThan, greaterThanOrEqualTo, intDenominator, intNumerator, intValue, lessThan, lessThanOrEqualTo, longDenominator, longNumerator, longValue, minus, modulo, numerator, plus, times

Methods inherited from interface org.zfcj.math.numbers.NaturalNumber

count0ToN, count0ToNMinus1, countNTo0, countNTo1, countTo, divide, modulo, plus, times

Methods inherited from interface org.zfcj.math.numbers.RationalNumber

dividedBy, isInt, isLong, minus, plus, reduce, times

Methods inherited from interface org.zfcj.math.numbers.RealNumber

abs, almostEquals, almostEquals, bigDecimalValue, dividedBy, greaterThan, greaterThanOrEqualTo, isDouble, lessThan, lessThanOrEqualTo, minus, modulo, plus, pow, times, truncate

Field Details

MAX_INT

static final PositiveInteger MAX_INT

Method Details

plus

default PositiveInteger plus(PositiveInteger n)

Returns the sum of this PositiveInteger and the given PositiveInteger

Specified by:

plus in interface NaturalNumber

Parameters:

n - the positive integer to sum

Returns:

the sum of positive integers

minusOne

default NaturalNumber minusOne()

Returns the NaturalNumber that is one less than this PositiveInteger

Returns:

this positive integer minus 1

times

default PositiveInteger times(PositiveInteger n)

Returns the product of this PositiveInteger and the given PositiveInteger

Parameters:

n - the positive integer to multiply

Returns:

the product of positive integers

divide

default PositiveInteger divide(PositiveInteger n)

Returns the quotient of dividing this PositiveInteger by the given PositiveInteger

Parameters:

n - the positive integer to divide by

Returns:

the quotient of positive integers

count1ToN

default Stream<PositiveInteger> count1ToN()

Returns a Stream of all PositiveIntegers in the range from One to this PositiveInteger

Returns:

a stream of PositiveIntegers

count1ToNMinus1

default Stream<PositiveInteger> count1ToNMinus1()

Returns a Stream of all PositiveIntegers in the range from One to this PositiveInteger minus 1

Returns:

a stream of PositiveIntegers

countNMinus1To0

default Stream<NaturalNumber> countNMinus1To0()

Returns a Stream of all NaturalNumbers in the range from this NaturalNumber minus 1 to Zero

Returns:

a stream of NaturalNumbers

countTo

default Stream<PositiveInteger> countTo(PositiveInteger i)

Returns a Stream of all PositiveIntegers in the range from this PositiveInteger to the given PositiveInteger

Parameters:

i - the positive integer to count o

Returns:

a stream of PositiveIntegers

of

static PositiveInteger of(int i)

Creates a new PositiveInteger whose value is the given int

Parameters:

i - the int value

Returns:

a PositiveInteger with the given value

Throws:

IllegalArgumentException - if i less than 1

of

static PositiveInteger of(long l)

Creates a new PositiveInteger whose value is the given long

Parameters:

l - the int value

Returns:

a PositiveInteger with the given value

Throws:

IllegalArgumentException - if l less than 1

of

static PositiveInteger of(BigInteger bi)

Creates a new PositiveInteger whose value is the given BigInteger

Parameters:

bi - the big integer value

Returns:

a PositiveInteger with the given value

Throws:

IllegalArgumentException - if bi less than 1

parse

static PositiveInteger parse(String s)

Creates a new PositiveInteger from the given string or throws an Exception if the string does not represent a PositiveInteger.

Parameters:

s - the "positive integer" string

Returns:

a PositiveInteger