Skip to content

Commit

Permalink
[FLINK-3786] [core] [api-extending] Add BigDecimal and BigInteger as …
Browse files Browse the repository at this point in the history
…Basic types

This closes apache#1928.
  • Loading branch information
twalthr committed May 2, 2016
1 parent 290a566 commit b3231ac
Show file tree
Hide file tree
Showing 19 changed files with 840 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/internals/types_serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ and, in specializations, comparators for the types.

Internally, Flink makes the following distinctions between types:

* Basic types: All Java primitives and their boxed form, plus `void`, `String`, and `Date`.
* Basic types: All Java primitives and their boxed form, plus `void`, `String`, `Date`, `BigDecimal`, and `BigInteger`.

* Primitive arrays and Object arrays

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
package org.apache.flink.api.common.typeinfo;

import java.lang.reflect.Constructor;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
Expand All @@ -31,6 +33,10 @@
import org.apache.flink.api.common.functions.InvalidTypesException;
import org.apache.flink.api.common.typeutils.TypeComparator;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.api.common.typeutils.base.BigDecComparator;
import org.apache.flink.api.common.typeutils.base.BigDecSerializer;
import org.apache.flink.api.common.typeutils.base.BigIntComparator;
import org.apache.flink.api.common.typeutils.base.BigIntSerializer;
import org.apache.flink.api.common.typeutils.base.BooleanComparator;
import org.apache.flink.api.common.typeutils.base.BooleanSerializer;
import org.apache.flink.api.common.typeutils.base.ByteComparator;
Expand All @@ -56,7 +62,8 @@
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
* Type information for primitive types (int, long, double, byte, ...), String, Date, and Void.
* Type information for primitive types (int, long, double, byte, ...), String, Date, Void,
* BigInteger, and BigDecimal.
*/
@Public
public class BasicTypeInfo<T> extends TypeInformation<T> implements AtomicType<T> {
Expand All @@ -74,6 +81,8 @@ public class BasicTypeInfo<T> extends TypeInformation<T> implements AtomicType<T
public static final BasicTypeInfo<Character> CHAR_TYPE_INFO = new BasicTypeInfo<Character>(Character.class, new Class<?>[]{}, CharSerializer.INSTANCE, CharComparator.class);
public static final BasicTypeInfo<Date> DATE_TYPE_INFO = new BasicTypeInfo<Date>(Date.class, new Class<?>[]{}, DateSerializer.INSTANCE, DateComparator.class);
public static final BasicTypeInfo<Void> VOID_TYPE_INFO = new BasicTypeInfo<Void>(Void.class, new Class<?>[]{}, VoidSerializer.INSTANCE, null);
public static final BasicTypeInfo<BigInteger> BIG_INT_TYPE_INFO = new BasicTypeInfo<BigInteger>(BigInteger.class, new Class<?>[]{}, BigIntSerializer.INSTANCE, BigIntComparator.class);
public static final BasicTypeInfo<BigDecimal> BIG_DEC_TYPE_INFO = new BasicTypeInfo<BigDecimal>(BigDecimal.class, new Class<?>[]{}, BigDecSerializer.INSTANCE, BigDecComparator.class);

// --------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -240,5 +249,7 @@ private static <X> TypeComparator<X> instantiateComparator(Class<? extends TypeC
TYPES.put(Date.class, DATE_TYPE_INFO);
TYPES.put(Void.class, VOID_TYPE_INFO);
TYPES.put(void.class, VOID_TYPE_INFO);
TYPES.put(BigInteger.class, BIG_INT_TYPE_INFO);
TYPES.put(BigDecimal.class, BIG_DEC_TYPE_INFO);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* https://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 org.apache.flink.api.common.typeutils.base;

import java.io.IOException;
import java.math.BigDecimal;
import org.apache.flink.annotation.Internal;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.MemorySegment;

/**
* Comparator for comparing BigDecimal values. Does not support null values.
*/
@Internal
public final class BigDecComparator extends BasicTypeComparator<BigDecimal> {

private static final long serialVersionUID = 1L;

private static final long SMALLEST_MAGNITUDE = Integer.MAX_VALUE;

private static final long LARGEST_MAGNITUDE = ((long) Integer.MIN_VALUE) - Integer.MAX_VALUE + 1;

public BigDecComparator(boolean ascending) {
super(ascending);
}

@Override
public int compareSerialized(DataInputView firstSource, DataInputView secondSource) throws IOException {
BigDecimal bd1 = BigDecSerializer.readBigDecimal(firstSource);
BigDecimal bd2 = BigDecSerializer.readBigDecimal(secondSource);
int comp = bd1.compareTo(bd2); // null is not supported
return ascendingComparison ? comp : -comp;
}

@Override
public boolean supportsNormalizedKey() {
return true;
}

@Override
public boolean supportsSerializationWithKeyNormalization() {
return false;
}

@Override
public int getNormalizeKeyLen() {
return 5;
}

@Override
public boolean isNormalizedKeyPrefixOnly(int keyBytes) {
return true;
}

/**
* Adds a normalized key containing a normalized order of magnitude of the given record.
* 2 bits determine the sign (negative, zero, positive), 33 bits determine the magnitude.
* This method adds at most 5 bytes that contain information.
*/
@Override
public void putNormalizedKey(BigDecimal record, MemorySegment target, int offset, int len) {
final long signum = record.signum();

// order of magnitude
// smallest:
// scale = Integer.MAX, precision = 1 => SMALLEST_MAGNITUDE
// largest:
// scale = Integer.MIN, precision = Integer.MAX => LARGEST_MAGNITUDE
final long mag = ((long) record.scale()) - ((long) record.precision()) + 1;

// normalize value range: from 0 to (SMALLEST_MAGNITUDE + -1*LARGEST_MAGNITUDE)
final long normMag = -1L * LARGEST_MAGNITUDE + mag;

// normalize value range dependent on sign:
// 0 to (SMALLEST_MAGNITUDE + -1*LARGEST_MAGNITUDE)
// OR (SMALLEST_MAGNITUDE + -1*LARGEST_MAGNITUDE) to 0
// --> uses at most 33 bit (5 least-significant bytes)
long signNormMag = signum < 0 ? normMag : (SMALLEST_MAGNITUDE + -1L * LARGEST_MAGNITUDE - normMag);

// zero has no magnitude
// set 34th bit to flag zero
if (signum == 0) {
signNormMag = 0L;
signNormMag |= (1L << 34);
}
// set 35th bit to flag positive sign
else if (signum > 0) {
signNormMag |= (1L << 35);
}

// add 5 least-significant bytes that contain value to target
for (int i = 0; i < 5 && len > 0; i++, len--) {
final byte b = (byte) (signNormMag >>> (8 * (4 - i)));
target.put(offset++, b);
}
}

@Override
public BigDecComparator duplicate() {
return new BigDecComparator(ascendingComparison);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* https://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 org.apache.flink.api.common.typeutils.base;

import java.io.IOException;
import java.math.BigDecimal;
import java.math.BigInteger;
import org.apache.flink.annotation.Internal;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.DataOutputView;

/**
* Serializer for serializing/deserializing BigDecimal values including null values.
*/
@Internal
public final class BigDecSerializer extends TypeSerializerSingleton<BigDecimal> {

private static final long serialVersionUID = 1L;

public static final BigDecSerializer INSTANCE = new BigDecSerializer();

@Override
public boolean isImmutableType() {
return true;
}

@Override
public BigDecimal createInstance() {
return BigDecimal.ZERO;
}

@Override
public BigDecimal copy(BigDecimal from) {
return from;
}

@Override
public BigDecimal copy(BigDecimal from, BigDecimal reuse) {
return from;
}

@Override
public int getLength() {
return -1;
}

@Override
public void serialize(BigDecimal record, DataOutputView target) throws IOException {
// null value support
if (record == null) {
BigIntSerializer.writeBigInteger(null, target);
return;
}
// fast paths for 0, 1, 10
// only reference equality is checked because equals would be too expensive
else if (record == BigDecimal.ZERO) {
BigIntSerializer.writeBigInteger(BigInteger.ZERO, target);
target.writeInt(0);
return;
}
else if (record == BigDecimal.ONE) {
BigIntSerializer.writeBigInteger(BigInteger.ONE, target);
target.writeInt(0);
return;
}
else if (record == BigDecimal.TEN) {
BigIntSerializer.writeBigInteger(BigInteger.TEN, target);
target.writeInt(0);
return;
}
// default
BigIntSerializer.writeBigInteger(record.unscaledValue(), target);
target.writeInt(record.scale());
}

@Override
public BigDecimal deserialize(DataInputView source) throws IOException {
return readBigDecimal(source);
}

@Override
public BigDecimal deserialize(BigDecimal reuse, DataInputView source) throws IOException {
return readBigDecimal(source);
}

@Override
public void copy(DataInputView source, DataOutputView target) throws IOException {
final boolean isNull = BigIntSerializer.copyBigInteger(source, target);
if (!isNull) {
final int scale = source.readInt();
target.writeInt(scale);
}
}

@Override
public boolean canEqual(Object obj) {
return obj instanceof BigDecSerializer;
}

// --------------------------------------------------------------------------------------------
// Static Helpers for BigInteger Serialization
// --------------------------------------------------------------------------------------------

public static BigDecimal readBigDecimal(DataInputView source) throws IOException {
final BigInteger unscaledValue = BigIntSerializer.readBigInteger(source);
if (unscaledValue == null) {
return null;
}
final int scale = source.readInt();
// fast-path for 0, 1, 10
if (scale == 0) {
if (unscaledValue == BigInteger.ZERO) {
return BigDecimal.ZERO;
}
else if (unscaledValue == BigInteger.ONE) {
return BigDecimal.ONE;
}
else if (unscaledValue == BigInteger.TEN) {
return BigDecimal.TEN;
}
}
// default
return new BigDecimal(unscaledValue, scale);
}
}
Loading

0 comments on commit b3231ac

Please sign in to comment.