All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.apexes.commons.lang.AsciiRadixCoder Maven / Gradle / Ivy

There is a newer version: 2.1.6
Show newest version
package net.apexes.commons.lang;

import java.util.Arrays;

public final class AsciiRadixCoder {

    private final byte[] chars;

    private final byte[] digits;

    private final RadixCoder byteCoder;

    /**
     * @throws IllegalArgumentException if {@code alphabet} has less than {@code 2} characters, repeated characters, or
     *                                  any characters which are not ASCII
     */
    private AsciiRadixCoder(String alphabet) {
        chars = new byte[alphabet.length()];
        digits = new byte[1 << 7];
        Arrays.fill(digits, (byte) -1);
        for (int i = 0; i < chars.length; i++) {
            byte c = checkAscii(alphabet.charAt(i));
            chars[i] = c;
            if (digits[c] != -1) throw new IllegalArgumentException("char '" + (char) c + "' is repeated in alphabet");
            digits[c] = (byte) i;
        }
        byteCoder = RadixCoder.u8(chars.length);
    }

    public static AsciiRadixCoder of(String alphabet) {
        return new AsciiRadixCoder(alphabet);
    }

    public int base() {
        return chars.length;
    }

    public String alphabet() {
        return new String(chars);
    }

    public String encode(byte[] bytes) {
        byte[] bs = byteCoder.encode(bytes);
        for (int i = 0; i < bs.length; i++) {
            bs[i] = chars[bs[i]];
        }
        return new String(bs);
    }

    /**
     * @throws IllegalArgumentException if {@code s} contains any characters which are not present in
     *                                  {@link #alphabet()}
     */
    public byte[] decode(String s) {
        byte[] bs = new byte[s.length()];
        for (int i = 0; i < bs.length; i++) {
            byte c = checkAscii(s.charAt(i));
            byte digit = digits[c];
            if (digit == -1) throw new IllegalArgumentException("char '" + (char) c + "' is not present in alphabet");
            bs[i] = digit;
        }
        return byteCoder.decode(bs);
    }

    private static byte checkAscii(char c) {
        if (c >= 1 << 7) throw new IllegalArgumentException("char '" + c + "' is not ascii");
        return (byte) c;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof AsciiRadixCoder)) return false;
        AsciiRadixCoder other = (AsciiRadixCoder) o;
        return Arrays.equals(chars, other.chars);
    }

    @Override
    public int hashCode() {
        return Arrays.hashCode(chars);
    }

    @Override
    public String toString() {
        return "AsciiRadixCoder(" + alphabet() + ')';
    }

    /**
     * @param  the primitive array type used to represent numbers
     */
    private static abstract class RadixCoder {

        public static final int BASE_MIN = 2;

        public static final int BASE_MAX_U8 = 0x100;

        public static final int BASE_MAX_U16 = 0x10000;

        protected final int base;

        protected final double encodeFactor;

        protected final double decodeFactor;

        RadixCoder(int base) {
            if (base < BASE_MIN) throw new IllegalArgumentException("base must be >= " + BASE_MIN);
            this.base = base;
            double logBase = Math.log(base);
            double logByte = Math.log(BASE_MAX_U8);
            encodeFactor = logByte / logBase;
            decodeFactor = logBase / logByte;
        }

        /**
         * Returns a {@code RadixCoder} for the given base.
         * It can convert between {@code byte} data and numbers represented as {@code byte} arrays.
         * Each digit of the number corresponds to an element of the array seen as an 8-bit unsigned integer.
         * Each digit must be less than {@code base}.
         *
         * @param base the base
         * @return a {@code RadixCoder} for the given base
         * @throws IllegalArgumentException if {@code base} is less than {@value #BASE_MIN} or greater than {@value #BASE_MAX_U8}
         */
        public static RadixCoder u8(int base) {
            return new RadixCoder.U8(base);
        }

        /**
         * Returns a {@code RadixCoder} for the given base.
         * It can convert between {@code byte} data and numbers represented as {@code short} arrays.
         * Each digit of the number corresponds to an element of the array seen as a 16-bit unsigned integer.
         * Each digit must be less than {@code base}.
         *
         * @param base the base
         * @return a {@code RadixCoder} for the given base
         * @throws IllegalArgumentException if {@code base} is less than {@value #BASE_MIN} or greater than {@value #BASE_MAX_U16}
         */
        public static RadixCoder u16(int base) {
            return new RadixCoder.U16(base);
        }

        /**
         * The base. This {@code RadixCoder} can convert between {@code byte} data and numbers with this base.
         *
         * @return the base
         */
        public final int base() {
            return base;
        }

        /**
         * Encodes bytes into a number.
         *
         * @param bytes bytes
         * @return a number encoded from {@code bytes}
         * @throws NullPointerException if {@code bytes} is {@code null}
         */
        public abstract N encode(byte[] bytes);

        /**
         * Decodes a number into bytes.
         *
         * @param n a number
         * @return bytes decoded from {@code n}
         * @throws IllegalArgumentException if {@code n} contains any digits greater than or equal to {@link #base()}
         * @throws NullPointerException     if {@code n} is {@code null}
         */
        public abstract byte[] decode(N n);

        @Override
        public final int hashCode() {
            return base;
        }

        @Override
        public final boolean equals(Object obj) {
            if (this == obj) return true;
            if (obj == null || getClass() != obj.getClass()) return false;
            return base == ((RadixCoder) obj).base;
        }

        @Override
        public final String toString() {
            return getClass().getName() + '(' + base + ')';
        }

        final void checkBaseMax(int max) {
            if (base > max) throw new IllegalArgumentException("base must be <= " + max);
        }

        final void checkDigitBase(int digit) {
            if (digit >= base) throw new IllegalArgumentException("digit must be < " + base);
        }


        private static final class U8 extends RadixCoder {

            U8(int base) {
                super(base);
                checkBaseMax(BASE_MAX_U8);
            }

            @Override
            public byte[] encode(byte[] bytes) {
                int zeroCount = leadingZeros(bytes);
                if (zeroCount == bytes.length) return new byte[bytes.length];
                int capacity = zeroCount + ceilMultiply(bytes.length - zeroCount, encodeFactor);
                byte[] dst = new byte[capacity];
                int j = capacity - 2;
                for (int i = zeroCount; i < bytes.length; i++) {
                    int carry = bytes[i] & 0xFF;
                    for (int k = capacity - 1; k > j; k--) {
                        carry += (dst[k] & 0xFF) << Byte.SIZE;
                        dst[k] = (byte) (carry % base);
                        carry /= base;
                    }
                    while (carry > 0) {
                        dst[j--] = (byte) (carry % base);
                        carry /= base;
                    }
                }
                return drop(dst, j - zeroCount + 1);
            }

            @Override
            public byte[] decode(byte[] n) {
                int zeroCount = leadingZeros(n);
                if (zeroCount == n.length) return new byte[n.length];
                int capacity = zeroCount + ceilMultiply(n.length - zeroCount, decodeFactor);
                byte[] dst = new byte[capacity];
                int j = capacity - 2;
                for (int i = zeroCount; i < n.length; i++) {
                    int carry = n[i] & 0xFF;
                    checkDigitBase(carry);
                    for (int k = capacity - 1; k > j; k--) {
                        carry += (dst[k] & 0xFF) * base;
                        dst[k] = (byte) carry;
                        carry >>>= Byte.SIZE;
                    }
                    while (carry > 0) {
                        dst[j--] = (byte) carry;
                        carry >>>= Byte.SIZE;
                    }
                }
                return drop(dst, j - zeroCount + 1);
            }
        }

        private static final class U16 extends RadixCoder {

            U16(int base) {
                super(base);
                checkBaseMax(BASE_MAX_U16);
            }

            @Override
            public short[] encode(byte[] bytes) {
                int zeroCount = leadingZeros(bytes);
                if (zeroCount == bytes.length) return new short[bytes.length];
                int capacity = zeroCount + ceilMultiply(bytes.length - zeroCount, encodeFactor);
                short[] dst = new short[capacity];
                int j = capacity - 2;
                for (int i = zeroCount; i < bytes.length; i++) {
                    int carry = bytes[i] & 0xFF;
                    for (int k = capacity - 1; k > j; k--) {
                        carry += (dst[k] & 0xFFFF) << Byte.SIZE;
                        dst[k] = (short) (carry % base);
                        carry /= base;
                    }
                    while (carry > 0) {
                        dst[j--] = (short) (carry % base);
                        carry /= base;
                    }
                }
                return drop(dst, j - zeroCount + 1);
            }

            @Override
            public byte[] decode(short[] n) {
                int zeroCount = leadingZeros(n);
                if (zeroCount == n.length) return new byte[n.length];
                int capacity = zeroCount + ceilMultiply(n.length - zeroCount, decodeFactor);
                byte[] dst = new byte[capacity];
                int j = capacity - 2;
                for (int i = zeroCount; i < n.length; i++) {
                    int carry = n[i] & 0xFFFF;
                    checkDigitBase(carry);
                    for (int k = capacity - 1; k > j; k--) {
                        carry += (dst[k] & 0xFF) * base;
                        dst[k] = (byte) carry;
                        carry >>>= Byte.SIZE;
                    }
                    while (carry > 0) {
                        dst[j--] = (byte) carry;
                        carry >>>= Byte.SIZE;
                    }
                }
                return drop(dst, j - zeroCount + 1);
            }
        }

        static int leadingZeros(byte[] a) {
            int zc = 0;
            while (zc < a.length && a[zc] == 0) zc++;
            return zc;
        }

        static int leadingZeros(short[] a) {
            int zc = 0;
            while (zc < a.length && a[zc] == 0) zc++;
            return zc;
        }

        static byte[] drop(byte[] a, int count) {
            return count == 0 ? a : Arrays.copyOfRange(a, count, a.length);
        }

        static short[] drop(short[] a, int count) {
            return count == 0 ? a : Arrays.copyOfRange(a, count, a.length);
        }

        static int ceilMultiply(int n, double f) {
            return (int) Math.ceil(n * f);
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy