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
|
/*
* fractal_transfer_function.h -- part of FractalNow
*
* Copyright (c) 2012 Marc Pegon <pe.marc@free.fr>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* \file fractal_transfer_function.h
* \brief Header file related to fractal transfer functions.
* \author Marc Pegon
*/
#ifndef __FRACTAL_TRANSFER_FUNCTION_H__
#define __FRACTAL_TRANSFER_FUNCTION_H__
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* \enum e_TransferFunction
* \brief Possible transfer functions.
*
* Transfer function are used to map fractal values to colors correctly.
*/
/**
* \typedef TransferFunction
* \brief Convenient typedef for enum TransferFunction.
*/
typedef enum e_TransferFunction {
TF_LOGLOG = 0,
/*<! Composition of two logarithms. */
TF_LOG,
/*<! Logarithm. */
TF_CUBEROOT,
/*<! Cube root. */
TF_SQUAREROOT,
/*<! Square root. */
TF_IDENTITY,
/*<! Identity. */
TF_SQUARE,
/*<! Square. */
TF_CUBE,
/*<! Cube. */
TF_EXP
/*<! Exponential. */
} TransferFunction;
/**
* \var nbTransferFunctions
* \brief Number of transfer functions.
*/
extern const uint_fast32_t nbTransferFunctions;
/**
* \var transferFunctionStr
* \brief Strings of transfer functions.
*/
extern const char *transferFunctionStr[];
/**
* \var transferFunctionDescStr
* \brief More descriptive strings for fractal addend functions.
*/
extern const char *transferFunctionDescStr[];
/**
* \typedef TransferFunctionPtr
* \brief Transfer function ptr type.
*/
typedef double (*TransferFunctionPtr)(double x);
/**
* \fn int GetTransferFunction(TransferFunction *transferFunction, const char *str)
* \brief Get transfer function enum value from string.
*
* Function is case insensitive.\n
* Possible strings are :
* - "log" for logarithm
* - "cuberoot" for cube root
* - "squareroot" for square root
* - "identity" for identity
* - "square" for square
* - "cube" for cube
* - "exp" for exponential
*
* \param transferFunction Transfer function destination.
* \param str String specifying transfer function.
* \return 0 in case of success, 1 in case of failure.
*/
int GetTransferFunction(TransferFunction *transferFunction, const char *str);
/**
* \fn TransferFunctionPtr GetTransferFunctionPtr(TransferFunction transferFunction)
* \brief Get transfer function ptr from transfer function enum value.
*
* \param transferFunction Transfer function enum value.
* \return Corresponding transfer function ptr.
*/
TransferFunctionPtr GetTransferFunctionPtr(TransferFunction transferFunction);
#ifdef __cplusplus
}
#endif
#endif
|
