class StringDigitList extends AbstractDigitList (View source)

Handles a list of digits provided as a string.

Properties

protected array $digits from AbstractDigitList
protected int[] $valueMap from AbstractDigitList
protected bool $caseSensitive from AbstractDigitList
protected bool $stringConflict from AbstractDigitList

Methods

setValueMap(array $map)

Sets the value map and determines if it's case sensitive.

bool
hasStringConflict()

Tells if there is conflict that prevents numbers from being represented as a string.

bool
isCaseSensitive()

Tells if the digits are case sensitive or not.

array
getDigits()

Returns all the digits in the list.

mixed
getDigit(int $value)

Returns the digit that represents the given value.

int
getValue(mixed $digit)

Returns the value for the given digit.

int
count()

Returns the number of different digits.

__construct(string $digits)

Creates a new instance of StringDigitList.

Details

protected setValueMap(array $map)

Sets the value map and determines if it's case sensitive.

Parameters

array $map List of values for digits

bool hasStringConflict()

Tells if there is conflict that prevents numbers from being represented as a string.

Return Value

bool True if a number cannot be represented using a string, false if it can

bool isCaseSensitive()

Tells if the digits are case sensitive or not.

Return Value

bool True if the digits are case sensitive, false if not

array getDigits()

Returns all the digits in the list.

Return Value

array List of digits in the list according to their value

mixed getDigit(int $value)

Returns the digit that represents the given value.

Parameters

int $value The value of the digit

Return Value

mixed The digit that represents the value

Exceptions

InvalidArgumentException If the value is invalid

int getValue(mixed $digit)

Returns the value for the given digit.

Parameters

mixed $digit Digit to search for

Return Value

int The value of the digit

Exceptions

InvalidDigitException if the digit is invalid

int count()

Returns the number of different digits.

Return Value

int the number of different digits

__construct(string $digits)

Creates a new instance of StringDigitList.

The list of digits must be provided as a string. Each character represents a single digit and the position in the string represents the value for that digit. For example, base 16 could be defined as 0123456789ABCDEF.

Parameters

string $digits Digits for the numeral system

Exceptions

InvalidArgumentException If the list of digits is invalid