-
Notifications
You must be signed in to change notification settings - Fork 0
/
mathworld.h
197 lines (153 loc) · 7.21 KB
/
mathworld.h
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
#pragma once
/****************************************************************************
** Copyright (c) 2023, Adel Kara Slimane <adel.ks@zegrapher.com>
**
** This file is part of ZeCalculator's source code.
**
** ZeCalculators is free software: you may copy, redistribute and/or modify it
** under the terms of the GNU Affero General Public License as published by the
** Free Software Foundation, either version 3 of the License, or (at your
** option) any later version.
**
** This file 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, see <http://www.gnu.org/licenses/>.
**
****************************************************************************/
#include <zecalculator/error.h>
#include <zecalculator/math_objects/builtin.h>
#include <zecalculator/math_objects/decl/dyn_math_object.h>
#include <zecalculator/math_objects/global_constant.h>
#include <zecalculator/math_objects/object_list.h>
#include <zecalculator/parsing/data_structures/ast.h>
#include <zecalculator/parsing/data_structures/deps.h>
#include <zecalculator/utils/name_map.h>
#include <zecalculator/utils/refs.h>
#include <zecalculator/utils/slotted_deque.h>
#include <zecalculator/utils/tuple.h>
#include <zecalculator/utils/utils.h>
#include <string>
#include <string_view>
#include <unordered_set>
namespace zc {
template <parsing::Type type>
class MathWorld;
namespace parsing {
template <Type type>
struct make_fast;
}
namespace fast {
using MathWorld = zc::MathWorld<parsing::Type::FAST>;
}
namespace rpn {
using MathWorld = zc::MathWorld<parsing::Type::RPN>;
}
class Ok {};
class UnregisteredObject {};
template <parsing::Type type>
class MathWorld
{
public:
using iterator = SlottedDeque<DynMathObject<type>>::iterator;
using const_iterator = SlottedDeque<DynMathObject<type>>::const_iterator;
/// @brief default constructor that defines the usual functions and global constants
MathWorld();
iterator begin();
const_iterator begin() const;
const_iterator cbegin() const;
iterator end();
const_iterator end() const;
const_iterator cend() const;
/// @brief get DynMathObject from 'slot'
/// @note returns nullptr if 'slot' is out of bounds or unassigned
DynMathObject<type>* get(size_t slot);
/// @note const version
const DynMathObject<type>* get(size_t slot) const;
/// @brief get DynMathObject from name
/// @note returns nullptr if 'name' does not refer to any known object
DynMathObject<type>* get(std::string_view name);
/// @note const version
const DynMathObject<type>* get(std::string_view name) const;
/// @brief get object 'ObjectType' from name
/// @note returns 'nullptr' if it does not exist
template <class ObjectType>
requires tuple_contains_v<MathObjects<type>, ObjectType>
ObjectType* get(std::string_view name);
/// @note const version
template <class ObjectType>
requires tuple_contains_v<MathObjects<type>, ObjectType>
const ObjectType* get(std::string_view name) const;
/// @brief get object 'ObjectType' from 'slot'
/// @note returns nullptr if 'slot' is out-of-bounds or unassigned
/// or the the object at that slot does not have the requested type
template <class ObjectType>
requires tuple_contains_v<MathObjects<type>, ObjectType>
ObjectType* get(size_t slot);
/// @note const version
template <class ObjectType>
requires tuple_contains_v<MathObjects<type>, ObjectType>
const ObjectType* get(size_t slot) const;
/// @brief returns a handle to a new math object
/// @note the expected within is in error state
DynMathObject<type>& new_object();
/// @brief says if an object with the given name exists within the world
bool contains(std::string_view name) const;
/// @brief gives the Functions and Variables the equation of this object directly depends on
/// @note uses only the equation of objects defined through an equation
/// -> undefined functions & variables in the math world will still be listed
/// @note return an empty container for objects not defined with an equation
deps::Deps direct_dependencies(std::string_view name) const;
/// @brief evaluates a given expression within this world
tl::expected<double, Error> evaluate(std::string expr) const;
/// @brief delete object given by pointer
/// @returns Ok if the deletion was successful, UnregisteredObject otherwise
/// when the pointed-to object is not handled by this instance of MathWorld
template <class ObjectType>
requires(tuple_contains_v<MathObjects<type>, ObjectType>)
tl::expected<Ok, UnregisteredObject> erase(ObjectType& obj);
/// @brief return the direct reverse dependencies, aka objects that depend directly on 'name'
deps::Deps direct_revdeps(std::string_view name) const;
/// @brief delete object given by pointer
/// @returns Ok if the deletion was successful, UnregisteredObject otherwise
/// when the pointed-to object is not handled by this instance of MathWorld
tl::expected<Ok, UnregisteredObject> erase(DynMathObject<type>& obj);
/// @brief delete object given by name
/// @returns Ok if the deletion was successful, UnregisteredObject otherwise
/// when no registered object has that given name
tl::expected<Ok, UnregisteredObject> erase(size_t slot);
/// @brief delete object given by name
/// @returns Ok if the deletion was successful, UnregisteredObject otherwise
/// when no registered object has that given name
tl::expected<Ok, UnregisteredObject> erase(const std::string& name);
protected:
/// @brief object at 'slot' changed name, became invalid / deleted, or got a new name
/// @note 'old_name' may be empty, in which case it's a new name
/// @note 'new_name' may be empty, in which case the object got deleted or is in an invalid state
void object_updated(size_t slot,
bool is_eq_object_now,
std::string old_name,
std::string new_name);
/// @brief checks that this object has actually been allocated in this world
bool sanity_check(const DynMathObject<type>& obj) const;
/// @brief return all the DynMathObjects (not necessarily in a valid state) that have an EqObject depend on 'names'
std::unordered_set<DynMathObject<type>*>
dependent_eq_objects(const std::unordered_set<std::string>& names);
/// @brief go through all functions that depend on 'old_name' or 'new_name' and rebind them
void rebind_dependent_functions(const std::unordered_set<std::string>& names);
/// @brief get DynMathObject that has an assigned eq_object (not necessarily in valid state)
const DynMathObject<type>* eq_object_get(std::string_view name) const;
DynMathObject<type>* eq_object_get(std::string_view name);
/// @brief maps an object name to its slot
name_map<size_t> inventory;
/// @brief object names defined through equations
name_map<size_t> eq_object_inventory;
SlottedDeque<DynMathObject<type>> math_objects;
friend DynMathObject<type>;
template <parsing::Type>
friend struct parsing::make_fast;
};
}