File: NativeArrayEncoding.java

package info (click to toggle)
libsis-base-java 18.09~pre1%2Bgit20180928.45fbd31%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,292 kB
  • sloc: java: 9,037; ansic: 813; xml: 160; sh: 139; makefile: 37
file content (184 lines) | stat: -rw-r--r-- 5,442 bytes parent folder | download | duplicates (3)
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*
 * 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.base.convert;

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

/**
 * An enum for encoding array of numbers (integer or float) in native (host) format.
 * 
 * @author Bernd Rinn
 */
public enum NativeArrayEncoding
{
    INT8_NATIVE(false, (byte) 1, NativeData.ByteOrder.NATIVE),

    INT16_LITTLE_ENDIAN(false, (byte) 2, NativeData.ByteOrder.LITTLE_ENDIAN),

    INT32_LITTLE_ENDIAN(false, (byte) 4, NativeData.ByteOrder.LITTLE_ENDIAN),

    INT64_LITTLE_ENDIAN(false, (byte) 8, NativeData.ByteOrder.LITTLE_ENDIAN),

    INT16_BIG_ENDIAN(false, (byte) 2, NativeData.ByteOrder.BIG_ENDIAN),

    INT32_BIG_ENDIAN(false, (byte) 4, NativeData.ByteOrder.BIG_ENDIAN),

    INT64_BIG_ENDIAN(false, (byte) 8, NativeData.ByteOrder.BIG_ENDIAN),

    FLOAT32_LITTLE_ENDIAN(true, (byte) 4, NativeData.ByteOrder.LITTLE_ENDIAN),

    FLOAT64_LITTLE_ENDIAN(true, (byte) 8, NativeData.ByteOrder.LITTLE_ENDIAN),

    FLOAT32_BIG_ENDIAN(true, (byte) 4, NativeData.ByteOrder.BIG_ENDIAN),

    FLOAT64_BIG_ENDIAN(true, (byte) 8, NativeData.ByteOrder.BIG_ENDIAN),

    ;

    private static final int MIN_ENCODING_HEADER_SIZE = 8;

    private static final int CHAR_N = 78;

    private static final int CHAR_B = 66;

    private static final int CHAR_L = 76;

    private static final int CHAR_I = 73;

    private static final int CHAR_F = 70;

    private boolean floatingPoint;

    private ByteOrder byteOrder;

    private byte sizeInBytes;

    private byte[] magic;

    NativeArrayEncoding(boolean floatingPoint, byte sizeInBytes, NativeData.ByteOrder byteOrder)
    {
        this.floatingPoint = floatingPoint;
        this.byteOrder = byteOrder;
        this.sizeInBytes = sizeInBytes;
        this.magic =
                new byte[]
                    {
                            (byte) (floatingPoint ? CHAR_F : CHAR_I),
                            (byte) ((byteOrder == ByteOrder.LITTLE_ENDIAN) ? CHAR_L
                                    : (byteOrder == ByteOrder.BIG_ENDIAN) ? CHAR_B : CHAR_N),
                            sizeInBytes };
    }

    /**
     * Returns <code>true</code>, if the encoded array is a float array.
     */
    public boolean isFloatingPoint()
    {
        return floatingPoint;
    }

    /**
     * Returns <code>true</code>, if the encoded array is an int array.
     */
    public boolean isInteger()
    {
        return floatingPoint == false;
    }

    /**
     * Returns the byte order of the array.
     */
    public NativeData.ByteOrder getByteOrder()
    {
        return byteOrder;
    }

    /**
     * Returns the size of one element in bytes.
     */
    public byte getSizeInBytes()
    {
        return sizeInBytes;
    }

    byte[] getMagic()
    {
        return magic;
    }

    static NativeArrayEncoding tryGetIntEncoding(ByteOrder byteOrder, byte sizeInBytes)
    {
        assert byteOrder != null;
        if (sizeInBytes == 1 && byteOrder == ByteOrder.NATIVE)
        {
            return INT8_NATIVE;
        } else if (sizeInBytes == 2)
        {
            return (byteOrder == ByteOrder.LITTLE_ENDIAN) ? INT16_LITTLE_ENDIAN : INT16_BIG_ENDIAN;
        } else if (sizeInBytes == 4)
        {
            return (byteOrder == ByteOrder.LITTLE_ENDIAN) ? INT32_LITTLE_ENDIAN : INT32_BIG_ENDIAN;

        } else if (sizeInBytes == 8)
        {
            return (byteOrder == ByteOrder.LITTLE_ENDIAN) ? INT64_LITTLE_ENDIAN : INT64_BIG_ENDIAN;
        }
        return null;
    }

    static NativeArrayEncoding tryGetFloatEncoding(ByteOrder byteOrder, byte sizeInBytes)
    {
        assert byteOrder != null;
        if (sizeInBytes == 4)
        {
            return (byteOrder == ByteOrder.LITTLE_ENDIAN) ? FLOAT32_LITTLE_ENDIAN
                    : FLOAT32_BIG_ENDIAN;
        } else if (sizeInBytes == 8)
        {
            return (byteOrder == ByteOrder.LITTLE_ENDIAN) ? FLOAT64_LITTLE_ENDIAN
                    : FLOAT64_BIG_ENDIAN;
        }
        return null;
    }

    /**
     * Returns the encoding for the given <var>byteArr</var>, or <code>null</code>, if
     * <var>byteArr</var> is not an encoded array.
     */
    public static NativeArrayEncoding tryGetEncoding(byte[] byteArr)
    {
        if (byteArr.length < MIN_ENCODING_HEADER_SIZE)
        {
            return null;
        }
        final ByteOrder byteOrder =
                (byteArr[1] == CHAR_L) ? ByteOrder.LITTLE_ENDIAN
                        : (byteArr[1] == CHAR_B) ? ByteOrder.BIG_ENDIAN : null;
        if (byteOrder == null)
        {
            return null;
        }
        if (byteArr[0] == CHAR_F)
        {
            return tryGetFloatEncoding(byteOrder, byteArr[2]);
        } else if (byteArr[0] == CHAR_I)
        {
            return tryGetIntEncoding(byteOrder, byteArr[2]);
        }
        return null;
    }
}