ion_decimal.h

Go to the documentation of this file.

/*
 * Copyright 2011-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at:
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */
 
#ifndef ION_DECIMAL_H_
#define ION_DECIMAL_H_
 
#include "ion_types.h"
#include "ion_platform_config.h"
 
#ifndef DECNUMDIGITS
    #error DECNUMDIGITS must be defined to be >= DECQUAD_Pmax
#elif DECNUMDIGITS < DECQUAD_Pmax
    #error DECNUMDIGITS must be defined to be >= DECQUAD_Pmax
#endif
 
#define ION_DECIMAL_STRLEN(ion_decimal) \
    ((size_t)(((ion_decimal)->type == ION_DECIMAL_TYPE_QUAD) \
        ? DECQUAD_String \
        : (((ion_decimal)->type == ION_DECIMAL_TYPE_UNKNOWN) \
            ? -1 \
            : ((ion_decimal)->value.num_value->digits + 14) /* +14 is specified by decNumberToString. */ \
        ) \
    ))
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/*
 * Internal structure definitions. The internals should NOT be depended upon (or cared about) by the end user.
 */
 
typedef enum {
    ION_DECIMAL_TYPE_UNKNOWN = 0,
    ION_DECIMAL_TYPE_QUAD = 1,
    ION_DECIMAL_TYPE_NUMBER = 2,
    ION_DECIMAL_TYPE_NUMBER_OWNED = 3,
 
} ION_DECIMAL_TYPE;
 
struct _ion_decimal {
 
    ION_DECIMAL_TYPE type;
 
    union {
        decQuad quad_value;
        decNumber *num_value;
    } value;
};
 
 
/* Memory management */
 
ION_API_EXPORT iERR ion_decimal_zero(ION_DECIMAL *value);
 
ION_API_EXPORT iERR ion_decimal_claim(ION_DECIMAL *value);
 
ION_API_EXPORT iERR ion_decimal_free(ION_DECIMAL *value);
 
 
/* Conversions */
 
ION_API_EXPORT iERR ion_decimal_to_string(const ION_DECIMAL *value, char *p_string);
 
ION_API_EXPORT iERR ion_decimal_from_string(ION_DECIMAL *value, const char *str, decContext *context);
 
ION_API_EXPORT iERR ion_decimal_from_uint32(ION_DECIMAL *value, uint32_t num);
 
ION_API_EXPORT iERR ion_decimal_from_int32(ION_DECIMAL *value, int32_t num);
 
ION_API_EXPORT iERR ion_decimal_from_quad(ION_DECIMAL *value, decQuad *quad);
 
ION_API_EXPORT iERR ion_decimal_from_number(ION_DECIMAL *value, decNumber *number);
 
ION_API_EXPORT iERR ion_decimal_from_ion_int(ION_DECIMAL *value, decContext *context, ION_INT *p_int);
 
ION_API_EXPORT iERR ion_decimal_to_ion_int(const ION_DECIMAL *value, decContext *context, ION_INT *p_int);
 
ION_API_EXPORT iERR ion_decimal_to_int32(const ION_DECIMAL *value, decContext *context, int32_t *p_int);
ION_API_EXPORT iERR ion_decimal_to_uint32(const ION_DECIMAL *value, decContext *context, uint32_t *p_int);
 
 
/* Operator APIs (computational) */
 
ION_API_EXPORT iERR ion_decimal_fma(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, const ION_DECIMAL *fhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_add(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_and(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_divide(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_divide_integer(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_max(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_max_mag(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_min(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_min_mag(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_multiply(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_or(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_quantize(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_remainder(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_remainder_near(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_rotate(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_scaleb(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_shift(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_subtract(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_xor(ION_DECIMAL *value, const ION_DECIMAL *lhs, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_abs(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_invert(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_logb(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_minus(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_plus(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_reduce(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_to_integral_exact(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
ION_API_EXPORT iERR ion_decimal_to_integral_value(ION_DECIMAL *value, const ION_DECIMAL *rhs, decContext *context);
 
 
/* Utility APIs (non-computational) */
 
ION_API_EXPORT uint32_t ion_decimal_digits(const ION_DECIMAL *value);
ION_API_EXPORT int32_t ion_decimal_get_exponent(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_radix(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_same_quantum(const ION_DECIMAL *lhs, const ION_DECIMAL *rhs);
ION_API_EXPORT uint32_t ion_decimal_is_integer(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_subnormal(const ION_DECIMAL *value, decContext *context);
ION_API_EXPORT uint32_t ion_decimal_is_normal(const ION_DECIMAL *value, decContext *context);
ION_API_EXPORT uint32_t ion_decimal_is_finite(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_infinite(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_nan(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_negative(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_zero(const ION_DECIMAL *value);
ION_API_EXPORT uint32_t ion_decimal_is_canonical(const ION_DECIMAL *value);
 
/* Comparisons */
 
ION_API_EXPORT iERR ion_decimal_compare(const ION_DECIMAL *left, const ION_DECIMAL *right, decContext *context, int32_t *result);
 
ION_API_EXPORT iERR ion_decimal_equals_quad(const decQuad *left, const decQuad *right, decContext *context, BOOL *is_equal);
 
ION_API_EXPORT iERR ion_decimal_equals(const ION_DECIMAL *left, const ION_DECIMAL *right, decContext *context, BOOL *is_equal);
 
/* Copies */
 
ION_API_EXPORT iERR ion_decimal_canonical(ION_DECIMAL *value, const ION_DECIMAL *rhs);
ION_API_EXPORT iERR ion_decimal_copy(ION_DECIMAL *value, const ION_DECIMAL *rhs);
ION_API_EXPORT iERR ion_decimal_copy_abs(ION_DECIMAL *value, const ION_DECIMAL *rhs);
ION_API_EXPORT iERR ion_decimal_copy_negate(ION_DECIMAL *value, const ION_DECIMAL *rhs);
ION_API_EXPORT iERR ion_decimal_copy_sign(ION_DECIMAL *value, const ION_DECIMAL *rhs, const ION_DECIMAL *lhs, decContext *context);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ION_DECIMAL_H_ */