File: UnsignedIntUtils.java

package info (click to toggle)
libsis-jhdf5-java 19.04.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 8,668 kB
  • sloc: java: 79,644; ansic: 18,986; sh: 309; makefile: 49; xml: 12
file content (144 lines) | stat: -rw-r--r-- 4,526 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
 * Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
 *
 * Licensed 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 ch.systemsx.cisd.hdf5;

import java.math.BigInteger;

import ch.systemsx.cisd.base.convert.NativeData;
import ch.systemsx.cisd.base.convert.NativeData.ByteOrder;

/**
 * Utilities for converting signed integers to unsigned integers and vice versa.
 * 
 * @author Bernd Rinn
 */
public final class UnsignedIntUtils
{
    private final static short MAX_UINT_8_P1 = 256;

    private final static short MAX_UINT_8 = MAX_UINT_8_P1 - 1;

    private final static int MAX_UINT_16_P1 = 65536;

    private final static int MAX_UINT_16 = MAX_UINT_16_P1 - 1;

    private final static long MAX_UINT_32_P1 = 4294967296L;

    private final static long MAX_UINT_32 = MAX_UINT_32_P1 - 1;

    private final static BigInteger MAX_UINT_64_P1 = new BigInteger("2").pow(64);

    private final static BigInteger MAX_UINT_64 = MAX_UINT_64_P1.subtract(BigInteger.ONE);

    /**
     * Converts <var>value</var> to <code>int8</code>.
     * 
     * @throws IllegalArgumentException if <var>value</var> is either negative or too large to fit
     *             into <code>uint8</code>.
     */
    public static byte toInt8(int value) throws IllegalArgumentException
    {
        if (value < 0 || value > MAX_UINT_8)
        {
            throw new IllegalArgumentException("Value " + Integer.toString(value)
                    + " cannot be converted to uint8.");
        }
        return (byte) value;
    }

    /**
     * Converts <var>value</var> as <code>int16</code>.
     * 
     * @throws IllegalArgumentException if <var>value</var> is either negative or too large to fit
     *             into <code>uint16</code>.
     */
    public static short toInt16(int value) throws IllegalArgumentException
    {
        if (value < 0 || value > MAX_UINT_16)
        {
            throw new IllegalArgumentException("Value " + Integer.toString(value)
                    + " cannot be converted to uint16.");
        }
        return (short) value;
    }

    /**
     * Converts <var>value</var> as <code>int32</code>.
     * 
     * @throws IllegalArgumentException if <var>value</var> is either negative or too large to fit
     *             into <code>uint32</code>.
     */
    public static int toInt32(long value) throws IllegalArgumentException
    {
        if (value < 0 || value > MAX_UINT_32)
        {
            throw new IllegalArgumentException("Value " + Long.toString(value)
                    + " cannot be converted to uint32.");
        }
        return (int) value;
    }

    /**
     * Converts <var>value</var> as <code>int64</code>.
     * 
     * @throws IllegalArgumentException if <var>value</var> is either negative or too large to fit
     *             into <code>uint64</code>.
     */
    public static long toInt64(BigInteger value) throws IllegalArgumentException
    {
        if (value.compareTo(BigInteger.ZERO) < 0 || value.compareTo(MAX_UINT_64) > 0)
        {
            throw new IllegalArgumentException("Value " + value.toString()
                    + " cannot be converted to uint64.");
        }
        return value.longValue();
    }

    /**
     * Converts <var>value</var> to <code>uint8</code>.
     */
    public static short toUint8(byte value)
    {
        return (short) (value < 0 ? MAX_UINT_8_P1 + value : value);
    }

    /**
     * Converts <var>value</var> to <code>uint16</code>.
     */
    public static int toUint16(short value)
    {
        return value < 0 ? MAX_UINT_16_P1 + value : value;
    }

    /**
     * Converts <var>value</var> to <code>uint32</code>.
     */
    public static long toUint32(int value)
    {
        return value < 0 ? MAX_UINT_32_P1 + value : value;
    }

    /**
     * Converts <var>value</var> to <code>uint64</code>.
     */
    public static BigInteger toUint64(long value)
    {
        return new BigInteger(1, NativeData.longToByte(new long[]
            { value }, ByteOrder.BIG_ENDIAN));
    }

}