/usr/include/converter.h is in libudunits2-dev 2.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | /*
* Copyright 2013 University Corporation for Atmospheric Research
*
* This file is part of the UDUNITS-2 package. See the file COPYRIGHT
* in the top-level source-directory of the package for copying and
* redistribution conditions.
*/
/*
* Public header-file for the Unidata units(3) library.
*/
#ifndef CV_CONVERTER_H_INCLUDED
#define CV_CONVERTER_H_INCLUDED
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef union cv_converter cv_converter;
/*
* Returns the trivial converter (i.e., y = x).
* When finished with the converter, the client should pass the converter to
* cv_free().
* RETURNS:
* The trivial converter.
*/
cv_converter*
cv_get_trivial(void);
/*
* Returns the reciprocal converter (i.e., y = 1/x).
* When finished with the converter, the client should pass the converter to
* cv_free().
* RETURNS:
* The reciprocal converter.
*/
cv_converter*
cv_get_inverse(void);
/*
* Returns a scaling converter (i.e., y = ax).
* When finished with the converter, the client should pass the converter to
* cv_free().
* RETURNS:
* The scaling converter.
*/
cv_converter*
cv_get_scale(
const double slope);
/*
* Returns a converter that adds a number to values (i.e., y = x + b).
* When finished with the converter, the client should pass the converter to
* cv_free().
* ARGUMENTS:
* intercept The number to be added.
* RETURNS:
* NULL Necessary memory couldn't be allocated.
* else A converter that adds the given number to values.
*/
cv_converter*
cv_get_offset(
const double intercept);
/*
* Returns a Galilean converter (i.e., y = ax + b).
* When finished with the converter, the client should pass the converter to
* cv_free().
* ARGUMENTS:
* slope The number by which to multiply values.
* intercept The number to be added.
* RETURNS:
* NULL Necessary memory couldn't be allocated.
* else A Galilean converter corresponding to the inputs.
*/
cv_converter*
cv_get_galilean(
const double slope,
const double intercept);
/*
* Returns a logarithmic converter (i.e., y = log(x) in some base).
* When finished with the converter, the client should pass the converter to
* cv_free().
* ARGUMENTS:
* base The logarithmic base (e.g., 2, M_E, 10). Must be
* greater than one.
* RETURNS:
* NULL "base" is not greater than one or necessary
* memory couldn't be allocated.
* else A logarithmic converter corresponding to the inputs.
*/
cv_converter*
cv_get_log(
const double base);
/*
* Returns an exponential converter (i.e., y = pow(b, x) in some base "b").
* When finished with the converter, the client should pass the converter to
* cv_free().
*
* Arguments:
* base The desired base. Must be positive.
* Returns:
* NULL "base" is invalid or necessary memory couldn't be
* allocated.
* else An exponential converter corresponding to the inputs.
*/
cv_converter*
cv_get_pow(
const double base);
/*
* Returns a converter corresponding to the sequential application of two
* other converters.
* ARGUMENTS:
* first The converter to be applied first.
* second The converter to be applied second.
* RETURNS:
* NULL Either "first" or "second" is NULL or necessary memory couldn't
* be allocated.
* else A converter corresponding to the sequential application of the
* given converters. If one of the input converters is the trivial
* converter, then the returned converter will be the other input
* converter.
*/
cv_converter*
cv_combine(
cv_converter* const first,
cv_converter* const second);
/*
* Frees resources associated with a converter.
* ARGUMENTS:
* conv The converter to have its resources freed or NULL.
*/
void
cv_free(
cv_converter* const conv);
/*
* Converts a float.
* ARGUMENTS:
* converter The converter.
* value The value to be converted.
* RETURNS:
* The converted value.
*/
float
cv_convert_float(
const cv_converter* converter,
const float value);
/*
* Converts a double.
* ARGUMENTS:
* converter The converter.
* value The value to be converted.
* RETURNS:
* The converted value.
*/
double
cv_convert_double(
const cv_converter* converter,
const double value);
/*
* Converts an array of floats.
* ARGUMENTS:
* converter The converter.
* in The values to be converted.
* count The number of values to be converted.
* out The output array for the converted values. May
* be the same array as "in" or overlap it.
* RETURNS:
* NULL "out" is NULL.
* else A pointer to the output array.
*/
float*
cv_convert_floats(
const cv_converter* converter,
const float* const in,
const size_t count,
float* out);
/*
* Converts an array of doubles.
* ARGUMENTS:
* converter The converter.
* in The values to be converted.
* count The number of values to be converted.
* out The output array for the converted values. May
* be the same array as "in" or overlap it.
* RETURNS:
* NULL "out" is NULL.
* else A pointer to the output array.
*/
double*
cv_convert_doubles(
const cv_converter* converter,
const double* const in,
const size_t count,
double* out);
/*
* Returns a string representation of a converter.
* ARGUMENTS:
* conv The converter.
* buf The buffer into which to write the expression.
* max The size of the buffer.
* variable The string to be used as the input value for the
* converter.
* RETURNS
* <0 An error was encountered.
* else The number of bytes formatted excluding the terminating null.
*/
int
cv_get_expression(
const cv_converter* const conv,
char* const buf,
size_t max,
const char* const variable);
#ifdef __cplusplus
}
#endif
#endif
|