@teachinglab/omd 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/README.md +257 -251
  2. package/README.old.md +137 -137
  3. package/canvas/core/canvasConfig.js +202 -202
  4. package/canvas/drawing/segment.js +167 -167
  5. package/canvas/drawing/stroke.js +385 -385
  6. package/canvas/events/eventManager.js +444 -444
  7. package/canvas/events/pointerEventHandler.js +262 -262
  8. package/canvas/index.js +48 -48
  9. package/canvas/tools/PointerTool.js +71 -71
  10. package/canvas/tools/tool.js +222 -222
  11. package/canvas/utils/boundingBox.js +377 -377
  12. package/canvas/utils/mathUtils.js +258 -258
  13. package/docs/api/configuration-options.md +198 -198
  14. package/docs/api/eventManager.md +82 -82
  15. package/docs/api/focusFrameManager.md +144 -144
  16. package/docs/api/index.md +105 -105
  17. package/docs/api/main.md +62 -62
  18. package/docs/api/omdBinaryExpressionNode.md +86 -86
  19. package/docs/api/omdCanvas.md +83 -83
  20. package/docs/api/omdConfigManager.md +112 -112
  21. package/docs/api/omdConstantNode.md +52 -52
  22. package/docs/api/omdDisplay.md +87 -87
  23. package/docs/api/omdEquationNode.md +174 -174
  24. package/docs/api/omdEquationSequenceNode.md +258 -258
  25. package/docs/api/omdEquationStack.md +192 -192
  26. package/docs/api/omdFunctionNode.md +82 -82
  27. package/docs/api/omdGroupNode.md +78 -78
  28. package/docs/api/omdHelpers.md +87 -87
  29. package/docs/api/omdLeafNode.md +85 -85
  30. package/docs/api/omdNode.md +201 -201
  31. package/docs/api/omdOperationDisplayNode.md +117 -117
  32. package/docs/api/omdOperatorNode.md +91 -91
  33. package/docs/api/omdParenthesisNode.md +133 -133
  34. package/docs/api/omdPopup.md +191 -191
  35. package/docs/api/omdPowerNode.md +131 -131
  36. package/docs/api/omdRationalNode.md +144 -144
  37. package/docs/api/omdSequenceNode.md +128 -128
  38. package/docs/api/omdSimplification.md +78 -78
  39. package/docs/api/omdSqrtNode.md +144 -144
  40. package/docs/api/omdStepVisualizer.md +146 -146
  41. package/docs/api/omdStepVisualizerHighlighting.md +65 -65
  42. package/docs/api/omdStepVisualizerInteractiveSteps.md +108 -108
  43. package/docs/api/omdStepVisualizerLayout.md +70 -70
  44. package/docs/api/omdStepVisualizerNodeUtils.md +140 -140
  45. package/docs/api/omdStepVisualizerTextBoxes.md +76 -76
  46. package/docs/api/omdToolbar.md +130 -130
  47. package/docs/api/omdTranscriptionService.md +95 -95
  48. package/docs/api/omdTreeDiff.md +169 -169
  49. package/docs/api/omdUnaryExpressionNode.md +137 -137
  50. package/docs/api/omdUtilities.md +82 -82
  51. package/docs/api/omdVariableNode.md +123 -123
  52. package/docs/api/selectTool.md +74 -74
  53. package/docs/api/simplificationEngine.md +97 -97
  54. package/docs/api/simplificationRules.md +76 -76
  55. package/docs/api/simplificationUtils.md +64 -64
  56. package/docs/api/transcribe.md +43 -43
  57. package/docs/api-reference.md +85 -85
  58. package/docs/index.html +453 -453
  59. package/docs/index.md +38 -38
  60. package/docs/omd-objects.md +258 -258
  61. package/index.js +79 -79
  62. package/jsvg/index.js +3 -0
  63. package/jsvg/jsvg.js +898 -898
  64. package/jsvg/jsvgComponents.js +357 -358
  65. package/npm-docs/DOCUMENTATION_SUMMARY.md +220 -220
  66. package/npm-docs/README.md +251 -251
  67. package/npm-docs/api/api-reference.md +85 -85
  68. package/npm-docs/api/configuration-options.md +198 -198
  69. package/npm-docs/api/eventManager.md +82 -82
  70. package/npm-docs/api/expression-nodes.md +561 -561
  71. package/npm-docs/api/focusFrameManager.md +144 -144
  72. package/npm-docs/api/index.md +105 -105
  73. package/npm-docs/api/main.md +62 -62
  74. package/npm-docs/api/omdBinaryExpressionNode.md +86 -86
  75. package/npm-docs/api/omdCanvas.md +83 -83
  76. package/npm-docs/api/omdConfigManager.md +112 -112
  77. package/npm-docs/api/omdConstantNode.md +52 -52
  78. package/npm-docs/api/omdDisplay.md +87 -87
  79. package/npm-docs/api/omdEquationNode.md +174 -174
  80. package/npm-docs/api/omdEquationSequenceNode.md +258 -258
  81. package/npm-docs/api/omdEquationStack.md +192 -192
  82. package/npm-docs/api/omdFunctionNode.md +82 -82
  83. package/npm-docs/api/omdGroupNode.md +78 -78
  84. package/npm-docs/api/omdHelpers.md +87 -87
  85. package/npm-docs/api/omdLeafNode.md +85 -85
  86. package/npm-docs/api/omdNode.md +201 -201
  87. package/npm-docs/api/omdOperationDisplayNode.md +117 -117
  88. package/npm-docs/api/omdOperatorNode.md +91 -91
  89. package/npm-docs/api/omdParenthesisNode.md +133 -133
  90. package/npm-docs/api/omdPopup.md +191 -191
  91. package/npm-docs/api/omdPowerNode.md +131 -131
  92. package/npm-docs/api/omdRationalNode.md +144 -144
  93. package/npm-docs/api/omdSequenceNode.md +128 -128
  94. package/npm-docs/api/omdSimplification.md +78 -78
  95. package/npm-docs/api/omdSqrtNode.md +144 -144
  96. package/npm-docs/api/omdStepVisualizer.md +146 -146
  97. package/npm-docs/api/omdStepVisualizerHighlighting.md +65 -65
  98. package/npm-docs/api/omdStepVisualizerInteractiveSteps.md +108 -108
  99. package/npm-docs/api/omdStepVisualizerLayout.md +70 -70
  100. package/npm-docs/api/omdStepVisualizerNodeUtils.md +140 -140
  101. package/npm-docs/api/omdStepVisualizerTextBoxes.md +76 -76
  102. package/npm-docs/api/omdToolbar.md +130 -130
  103. package/npm-docs/api/omdTranscriptionService.md +95 -95
  104. package/npm-docs/api/omdTreeDiff.md +169 -169
  105. package/npm-docs/api/omdUnaryExpressionNode.md +137 -137
  106. package/npm-docs/api/omdUtilities.md +82 -82
  107. package/npm-docs/api/omdVariableNode.md +123 -123
  108. package/npm-docs/api/selectTool.md +74 -74
  109. package/npm-docs/api/simplificationEngine.md +97 -97
  110. package/npm-docs/api/simplificationRules.md +76 -76
  111. package/npm-docs/api/simplificationUtils.md +64 -64
  112. package/npm-docs/api/transcribe.md +43 -43
  113. package/npm-docs/guides/equations.md +854 -854
  114. package/npm-docs/guides/factory-functions.md +354 -354
  115. package/npm-docs/guides/getting-started.md +318 -318
  116. package/npm-docs/guides/quick-examples.md +525 -525
  117. package/npm-docs/guides/visualizations.md +682 -682
  118. package/npm-docs/index.html +12 -0
  119. package/npm-docs/json-schemas.md +826 -826
  120. package/omd/config/omdConfigManager.js +279 -267
  121. package/omd/core/index.js +158 -158
  122. package/omd/core/omdEquationStack.js +546 -546
  123. package/omd/core/omdUtilities.js +113 -113
  124. package/omd/display/omdDisplay.js +969 -962
  125. package/omd/display/omdToolbar.js +501 -501
  126. package/omd/nodes/omdBinaryExpressionNode.js +459 -459
  127. package/omd/nodes/omdConstantNode.js +141 -141
  128. package/omd/nodes/omdEquationNode.js +1327 -1327
  129. package/omd/nodes/omdFunctionNode.js +351 -351
  130. package/omd/nodes/omdGroupNode.js +67 -67
  131. package/omd/nodes/omdLeafNode.js +76 -76
  132. package/omd/nodes/omdNode.js +556 -556
  133. package/omd/nodes/omdOperationDisplayNode.js +321 -321
  134. package/omd/nodes/omdOperatorNode.js +108 -108
  135. package/omd/nodes/omdParenthesisNode.js +292 -292
  136. package/omd/nodes/omdPowerNode.js +235 -235
  137. package/omd/nodes/omdRationalNode.js +295 -295
  138. package/omd/nodes/omdSqrtNode.js +307 -307
  139. package/omd/nodes/omdUnaryExpressionNode.js +227 -227
  140. package/omd/nodes/omdVariableNode.js +122 -122
  141. package/omd/simplification/omdSimplification.js +140 -140
  142. package/omd/simplification/omdSimplificationEngine.js +887 -887
  143. package/omd/simplification/package.json +5 -5
  144. package/omd/simplification/rules/binaryRules.js +1037 -1037
  145. package/omd/simplification/rules/functionRules.js +111 -111
  146. package/omd/simplification/rules/index.js +48 -48
  147. package/omd/simplification/rules/parenthesisRules.js +19 -19
  148. package/omd/simplification/rules/powerRules.js +143 -143
  149. package/omd/simplification/rules/rationalRules.js +725 -725
  150. package/omd/simplification/rules/sqrtRules.js +48 -48
  151. package/omd/simplification/rules/unaryRules.js +37 -37
  152. package/omd/simplification/simplificationRules.js +31 -31
  153. package/omd/simplification/simplificationUtils.js +1055 -1055
  154. package/omd/step-visualizer/omdStepVisualizer.js +947 -947
  155. package/omd/step-visualizer/omdStepVisualizerHighlighting.js +246 -246
  156. package/omd/step-visualizer/omdStepVisualizerLayout.js +892 -892
  157. package/omd/step-visualizer/omdStepVisualizerTextBoxes.js +200 -200
  158. package/omd/utils/aiNextEquationStep.js +106 -106
  159. package/omd/utils/omdNodeOverlay.js +638 -638
  160. package/omd/utils/omdPopup.js +1203 -1203
  161. package/omd/utils/omdStepVisualizerInteractiveSteps.js +684 -684
  162. package/omd/utils/omdStepVisualizerNodeUtils.js +267 -267
  163. package/omd/utils/omdTranscriptionService.js +123 -123
  164. package/omd/utils/omdTreeDiff.js +733 -733
  165. package/package.json +59 -56
  166. package/readme.html +184 -120
  167. package/src/index.js +74 -74
  168. package/src/json-schemas.md +576 -576
  169. package/src/omd-json-samples.js +147 -147
  170. package/src/omdApp.js +391 -391
  171. package/src/omdAppCanvas.js +335 -335
  172. package/src/omdBalanceHanger.js +199 -199
  173. package/src/omdColor.js +13 -13
  174. package/src/omdCoordinatePlane.js +541 -541
  175. package/src/omdExpression.js +115 -115
  176. package/src/omdFactory.js +150 -150
  177. package/src/omdFunction.js +114 -114
  178. package/src/omdMetaExpression.js +290 -290
  179. package/src/omdNaturalExpression.js +563 -563
  180. package/src/omdNode.js +383 -383
  181. package/src/omdNumber.js +52 -52
  182. package/src/omdNumberLine.js +114 -112
  183. package/src/omdNumberTile.js +118 -118
  184. package/src/omdOperator.js +72 -72
  185. package/src/omdPowerExpression.js +91 -91
  186. package/src/omdProblem.js +259 -259
  187. package/src/omdRatioChart.js +251 -251
  188. package/src/omdRationalExpression.js +114 -114
  189. package/src/omdSampleData.js +215 -215
  190. package/src/omdShapes.js +512 -512
  191. package/src/omdSpinner.js +151 -151
  192. package/src/omdString.js +49 -49
  193. package/src/omdTable.js +498 -498
  194. package/src/omdTapeDiagram.js +244 -244
  195. package/src/omdTerm.js +91 -91
  196. package/src/omdTileEquation.js +349 -349
  197. package/src/omdUtils.js +84 -84
  198. package/src/omdVariable.js +51 -51
@@ -1,460 +1,460 @@
1
- import { omdNode } from "./omdNode.js";
2
- import { getNodeForAST } from "../core/omdUtilities.js";
3
- import { omdOperatorNode } from "./omdOperatorNode.js";
4
- import { omdConstantNode } from "./omdConstantNode.js";
5
- import { omdVariableNode } from "./omdVariableNode.js";
6
- import { omdPowerNode } from "./omdPowerNode.js";
7
- import { omdParenthesisNode } from "./omdParenthesisNode.js";
8
- import { useImplicitMultiplication } from "../config/omdConfigManager.js";
9
- import { simplifyStep } from "../simplification/omdSimplification.js";
10
-
11
- /**
12
- * Represents a binary expression node in the mathematical expression tree
13
- * Handles rendering of expressions with two operands and an operator
14
- * @extends omdNode
15
- */
16
- export class omdBinaryExpressionNode extends omdNode {
17
- /**
18
- * Creates a binary expression node from AST data
19
- * @param {Object} ast - The AST node containing binary expression information
20
- */
21
- constructor(ast) {
22
- super(ast);
23
- this.type = "omdBinaryExpressionNode";
24
- if (!ast.args?.length || ast.args.length < 2) {
25
- throw new Error(`omdBinaryExpressionNode requires an AST node with at least 2 arguments. Received: ${JSON.stringify(ast)}`);
26
- }
27
-
28
- this.left = this.createExpressionNode(ast.args[0]);
29
- this.argumentNodeList.left = this.left;
30
-
31
- this.operation = this.parseOperation();
32
- this.op = !ast.implicit ? this.createOperatorNode(ast) : null; // Gerard: Implicit multiplication does not include operator node
33
- this.isImplicit = ast.implicit || false;
34
-
35
- this.right = this.createExpressionNode(ast.args[1]);
36
- this.argumentNodeList.right = this.right;
37
-
38
- // Convert explicit multiplication to implicit based on configuration
39
- if (this.op && (ast.op === '*' || ast.op === '×' || ast.fn === 'multiply')) {
40
- // Check if we should reorder operands (e.g., x*2 -> 2x)
41
- if (this._shouldReorderMultiplication(this.left, this.right)) {
42
- // Swap left and right operands
43
- const temp = this.left;
44
- this.left = this.right;
45
- this.right = temp;
46
-
47
- // Update argument list
48
- this.argumentNodeList.left = this.left;
49
- this.argumentNodeList.right = this.right;
50
-
51
- // Update AST args as well for consistency
52
- const tempArg = this.astNodeData.args[0];
53
- this.astNodeData.args[0] = this.astNodeData.args[1];
54
- this.astNodeData.args[1] = tempArg;
55
- }
56
-
57
- if (this._shouldUseImplicitMultiplication(this.left, this.right)) {
58
- // Remove the operator node to treat as implicit multiplication
59
- this.removeChild(this.op);
60
- this.op = null;
61
-
62
- // Mark AST as implicit for cloning/mathjs compatibility
63
- this.astNodeData.implicit = true;
64
- }
65
- }
66
- }
67
-
68
- parseOperation() {
69
- return this.astNodeData.fn;
70
- }
71
-
72
- createExpressionNode(ast) {
73
- let NodeType = getNodeForAST(ast);
74
- let child = new NodeType(ast);
75
- this.addChild(child);
76
-
77
- return child;
78
- }
79
-
80
- createOperatorNode(ast) {
81
- let opAst = { type: "OperatorNode", op: ast.op };
82
- if (ast.operatorProvenance) {
83
- opAst.provenance = ast.operatorProvenance;
84
- }
85
- let op = new omdOperatorNode(opAst);
86
- this.addChild(op);
87
-
88
- return op;
89
- }
90
-
91
- computeDimensions() {
92
- // Compute dimensions for all children first
93
- this.left.computeDimensions();
94
- this.op?.computeDimensions();
95
- this.right.computeDimensions();
96
-
97
- // Gerard: Calculate dimensions based on child dimensions
98
- let sumChildrenWidth = this.left.width + this.right.width + (this.op !== null ? this.op.width : 0);
99
- let maxChildrenHeight = Math.max(this.left.height, this.right.height);
100
-
101
- // Gerard: Add spacing between op and operands, if there is an op (not implicit)
102
- let padding = 0 * this.getFontSize() / this.getRootFontSize(); // Gerard: Vertical padding, should scale with fontSize
103
- let spacedWidth = sumChildrenWidth + this.getSpacing() * 2;
104
- let spacedHeight = maxChildrenHeight + padding;
105
-
106
- this.setWidthAndHeight(spacedWidth, spacedHeight);
107
- }
108
-
109
- updateLayout() {
110
- const spacing = this.getSpacing();
111
- const maxBaseline = Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
112
- let xOffset = 0;
113
-
114
- // Position children so their baselines align.
115
- this.left.updateLayout();
116
- this.left.setPosition(xOffset, maxBaseline - this.left.getAlignmentBaseline());
117
- xOffset += this.left.width + spacing;
118
-
119
- if (this.op !== null) {
120
- // Center the operator on the max baseline.
121
- const opBaseline = this.op.getAlignmentBaseline();
122
- this.op.updateLayout();
123
- this.op.setPosition(xOffset, maxBaseline - opBaseline);
124
- xOffset += this.op.width + spacing;
125
- }
126
-
127
- this.right.updateLayout();
128
- this.right.setPosition(xOffset, maxBaseline - this.right.getAlignmentBaseline());
129
- }
130
-
131
- /**
132
- * The alignment baseline for a binary expression should be the baseline of its operator,
133
- * adjusted for its position within the expression's bounding box.
134
- * @override
135
- * @returns {number} The y-coordinate for alignment.
136
- */
137
- getAlignmentBaseline() {
138
- if (this.op) {
139
- // The true baseline is the baseline of the operator, plus the operator's y-offset.
140
- const maxChildBaseline = Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
141
- const op_yOffset = maxChildBaseline - this.op.getAlignmentBaseline();
142
- return op_yOffset + this.op.getAlignmentBaseline();
143
- }
144
- // If there's no operator (implicit multiplication), the expression's baseline
145
- // is the shared alignment baseline of its children.
146
- return Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
147
- }
148
-
149
- clone() {
150
- // Create a new node. The constructor will add a backRect and temporary children.
151
- const tempAst = { type: 'OperatorNode', op: '+', args: [{type: 'ConstantNode', value: 1}, {type: 'ConstantNode', value: 1}] };
152
- const clone = new omdBinaryExpressionNode(tempAst);
153
-
154
- // Keep the backRect, but get rid of the temporary children.
155
- const backRect = clone.backRect;
156
- clone.removeAllChildren();
157
- clone.addChild(backRect);
158
-
159
- // Manually clone the real children to ensure the entire tree has correct provenance.
160
- clone.left = this.left.clone();
161
- clone.addChild(clone.left);
162
-
163
- if (this.op) {
164
- clone.op = this.op.clone();
165
- clone.addChild(clone.op);
166
- } else {
167
- clone.op = null;
168
- }
169
-
170
- clone.right = this.right.clone();
171
- clone.addChild(clone.right);
172
-
173
- // Rebuild the argument list, operation, and copy AST data.
174
- clone.argumentNodeList = { left: clone.left, right: clone.right };
175
- clone.operation = this.operation;
176
- clone.astNodeData = JSON.parse(JSON.stringify(this.astNodeData));
177
-
178
- // The crucial step: link the clone to its origin.
179
- clone.provenance.push(this.id);
180
-
181
- return clone;
182
- }
183
-
184
- // Gerard: Calculator horizontal spacing depending on whether op is implicit and scaling with font size
185
- getSpacing() {
186
- if (this.op === null) return 0;
187
-
188
- return 6 * this.getFontSize() / this.getRootFontSize();
189
- }
190
-
191
- /**
192
- * Determines if implicit multiplication should be used based on configuration
193
- * @private
194
- * @param {omdNode} left - Left operand
195
- * @param {omdNode} right - Right operand
196
- * @returns {boolean}
197
- */
198
- _shouldUseImplicitMultiplication(left, right) {
199
- // If global implicit multiplication is disabled, use traditional logic
200
- if (!useImplicitMultiplication()) {
201
- return this._isCoefficientMultiplication(left, right);
202
- }
203
-
204
- // Check specific combinations based on configuration
205
- const leftType = this._getNodeCategory(left);
206
- const rightType = this._getNodeCategory(right);
207
-
208
- const combinationKey = `${leftType}-${rightType}`;
209
- return this._getImplicitMultiplicationSetting(combinationKey);
210
- }
211
-
212
- /**
213
- * Gets the implicit multiplication setting for a given combination
214
- * Converts kebab-case combination keys to camelCase config keys
215
- * @private
216
- * @param {string} combinationKey - The combination key (e.g., 'constant-variable')
217
- * @returns {boolean} Whether implicit multiplication should be used
218
- */
219
- _getImplicitMultiplicationSetting(combinationKey) {
220
- // Handle special reordering cases that map to the same config setting
221
- const reorderingMappings = {
222
- 'variable-constant': 'constant-variable', // x*3 -> 3x (reordered)
223
- 'parenthesis-constant': 'constant-parenthesis' // (x+1)*3 -> 3(x+1) (reordered)
224
- };
225
-
226
- // Use the mapping if it exists, otherwise use the original key
227
- const normalizedKey = reorderingMappings[combinationKey] || combinationKey;
228
-
229
- // Convert kebab-case to camelCase (e.g., 'constant-variable' -> 'constantVariable')
230
- const camelCaseKey = normalizedKey.replace(/-([a-z])/g, (match, letter) => letter.toUpperCase());
231
-
232
- return useImplicitMultiplication(camelCaseKey);
233
- }
234
-
235
- /**
236
- * Categorizes a node for implicit multiplication rules
237
- * @private
238
- * @param {omdNode} node - The node to categorize
239
- * @returns {string} The category name
240
- */
241
- _getNodeCategory(node) {
242
- if (node instanceof omdConstantNode && node.isConstant()) {
243
- return 'constant';
244
- }
245
- if (node instanceof omdVariableNode) {
246
- return 'variable';
247
- }
248
- if (node instanceof omdPowerNode) {
249
- return 'power';
250
- }
251
- if (node instanceof omdParenthesisNode) {
252
- return 'parenthesis';
253
- }
254
- return 'other';
255
- }
256
-
257
- /**
258
- * Determines if multiplication operands should be reordered for conventional display
259
- * (e.g., x*2 -> 2x, y*3 -> 3y)
260
- * @private
261
- * @param {omdNode} left - Left operand
262
- * @param {omdNode} right - Right operand
263
- * @returns {boolean} True if operands should be swapped
264
- */
265
- _shouldReorderMultiplication(left, right) {
266
- const leftType = this._getNodeCategory(left);
267
- const rightType = this._getNodeCategory(right);
268
-
269
- // Reorder if: left is non-constant and right is constant
270
- // Examples: x*2 -> 2x, y*3 -> 3y, (x+1)*5 -> 5(x+1)
271
- return (leftType !== 'constant' && rightType === 'constant');
272
- }
273
-
274
- /**
275
- * Determines if the multiplication represents a coefficient (e.g. 3*x -> 3x)
276
- * @private
277
- * @param {omdNode} left - Left operand
278
- * @param {omdNode} right - Right operand
279
- * @returns {boolean}
280
- */
281
- _isCoefficientMultiplication(left, right) {
282
- const leftIsNumericConstant = left instanceof omdConstantNode && left.isConstant();
283
- const rightIsVariableLike = (
284
- right instanceof omdVariableNode ||
285
- right instanceof omdPowerNode ||
286
- right instanceof omdParenthesisNode
287
- );
288
- return leftIsNumericConstant && rightIsVariableLike;
289
- }
290
-
291
- /**
292
- * Converts the omdBinaryExpressionNode to a math.js AST node.
293
- * @returns {Object} A math.js-compatible AST node.
294
- */
295
- toMathJSNode() {
296
- const astNode = {
297
- type: 'OperatorNode',
298
- op: this.op ? this.op.opName : '*',
299
- fn: this.operation,
300
- args: [this.left.toMathJSNode(), this.right.toMathJSNode()],
301
- implicit: !this.op,
302
- id: this.id,
303
- provenance: this.provenance
304
- };
305
-
306
- // Add a clone method to maintain compatibility with math.js's expectations.
307
- astNode.clone = function() {
308
- const clonedNode = { ...this };
309
- clonedNode.args = this.args.map(arg => arg.clone());
310
- return clonedNode;
311
- };
312
- return astNode;
313
- }
314
-
315
- /**
316
- * Converts the binary expression node to a string.
317
- * @returns {string} The string representation of the expression.
318
- */
319
- toString() {
320
- const leftStr = this.left.toString();
321
- const rightStr = this.right.toString();
322
- const opStr = this.op ? ` ${this.op.toString()} ` : '';
323
-
324
- // Handle implicit multiplication case (no operator)
325
- if (!this.op) {
326
- return `${leftStr}${rightStr}`;
327
- }
328
-
329
- // Wrap children in parentheses if their precedence is lower than this node's.
330
- const finalLeft = this.left.needsParentheses && this.left.needsParentheses(this.op.value) ? `(${leftStr})` : leftStr;
331
- const finalRight = this.right.needsParentheses && this.right.needsParentheses(this.op.value) ? `(${rightStr})` : rightStr;
332
-
333
- return `${finalLeft}${opStr}${finalRight}`;
334
- }
335
-
336
- /**
337
- * Evaluates the expression by recursively evaluating children.
338
- * @param {Object} variables - A map of variable names to their numeric values.
339
- * @returns {number} The result of the expression.
340
- */
341
- evaluate(variables = {}) {
342
- const operations = {
343
- 'add': (a, b) => a + b,
344
- 'subtract': (a, b) => a - b,
345
- 'multiply': (a, b) => a * b,
346
- 'divide': (a, b) => {
347
- if (b === 0) throw new Error("Division by zero.");
348
- return a / b;
349
- }
350
- };
351
-
352
- const leftVal = this.left.evaluate(variables);
353
- const rightVal = this.right.evaluate(variables);
354
-
355
- if (this.isImplicit) {
356
- return leftVal * rightVal;
357
- }
358
-
359
- const func = operations[this.operation];
360
-
361
- if (func) {
362
- return func(leftVal, rightVal);
363
- }
364
-
365
- throw new Error(`Unsupported operation for evaluation: ${this.operation}`);
366
- }
367
-
368
- /**
369
- * Determine if parentheses are needed based on parent operator
370
- * @returns {boolean} Whether parentheses are required
371
- */
372
- needsParentheses() {
373
- const parent = this.parent;
374
- if (!parent || !(parent instanceof omdBinaryExpressionNode)) {
375
- return false;
376
- }
377
-
378
- const thisOp = this.op ? this.op.opName : '*';
379
- const parentOp = parent.op ? parent.op.opName : '*';
380
-
381
- const precedence = {
382
- '+': 1,
383
- '-': 1,
384
- '*': 2,
385
- '×': 2,
386
- '/': 2,
387
- '÷': 2,
388
- '^': 3
389
- };
390
-
391
- const thisPrecedence = precedence[thisOp] || 0;
392
- const parentPrecedence = precedence[parentOp] || 0;
393
-
394
- // Need parentheses if this operation has lower precedence than parent
395
- if (thisPrecedence < parentPrecedence) {
396
- return true;
397
- }
398
-
399
- // Special case: subtraction and division are left-associative
400
- // So (a - b) - c needs parentheses on the right: a - (b - c)
401
- if (thisPrecedence === parentPrecedence && parent.right === this) {
402
- if (thisOp === '-' || thisOp === '/' || thisOp === '÷') {
403
- return true;
404
- }
405
- }
406
-
407
- return false;
408
- }
409
-
410
- /**
411
- * Helper method to get function name from operator
412
- * @private
413
- * @param {string} op - The operator symbol
414
- * @returns {string} The function name
415
- */
416
- getFunctionForOperator(op) {
417
- const opMap = {
418
- '+': 'add',
419
- '-': 'subtract',
420
- '*': 'multiply',
421
- '×': 'multiply',
422
- '/': 'divide',
423
- '÷': 'divide'
424
- };
425
- return opMap[op] || 'unknown';
426
- }
427
-
428
- setHighlight(highlightOn = true, color = omdColor.highlightColor) {
429
- if (this.isExplainHighlighted) return; // Respect the lock
430
-
431
- // Highlight/unhighlight the binary expression itself
432
- super.setHighlight(highlightOn, color);
433
-
434
- // Also highlight/unhighlight the children (left operand, operator, right operand)
435
- if (this.left && typeof this.left.setHighlight === 'function') {
436
- this.left.setHighlight(highlightOn, color);
437
- }
438
- if (this.op && typeof this.op.setHighlight === 'function') {
439
- this.op.setHighlight(highlightOn, color);
440
- }
441
- if (this.right && typeof this.right.setHighlight === 'function') {
442
- this.right.setHighlight(highlightOn, color);
443
- }
444
- }
445
-
446
- clearProvenanceHighlights() {
447
- super.clearProvenanceHighlights();
448
-
449
- // Also clear highlights from children
450
- if (this.left && typeof this.left.clearProvenanceHighlights === 'function') {
451
- this.left.clearProvenanceHighlights();
452
- }
453
- if (this.op && typeof this.op.clearProvenanceHighlights === 'function') {
454
- this.op.clearProvenanceHighlights();
455
- }
456
- if (this.right && typeof this.right.clearProvenanceHighlights === 'function') {
457
- this.right.clearProvenanceHighlights();
458
- }
459
- }
1
+ import { omdNode } from "./omdNode.js";
2
+ import { getNodeForAST } from "../core/omdUtilities.js";
3
+ import { omdOperatorNode } from "./omdOperatorNode.js";
4
+ import { omdConstantNode } from "./omdConstantNode.js";
5
+ import { omdVariableNode } from "./omdVariableNode.js";
6
+ import { omdPowerNode } from "./omdPowerNode.js";
7
+ import { omdParenthesisNode } from "./omdParenthesisNode.js";
8
+ import { useImplicitMultiplication } from "../config/omdConfigManager.js";
9
+ import { simplifyStep } from "../simplification/omdSimplification.js";
10
+
11
+ /**
12
+ * Represents a binary expression node in the mathematical expression tree
13
+ * Handles rendering of expressions with two operands and an operator
14
+ * @extends omdNode
15
+ */
16
+ export class omdBinaryExpressionNode extends omdNode {
17
+ /**
18
+ * Creates a binary expression node from AST data
19
+ * @param {Object} ast - The AST node containing binary expression information
20
+ */
21
+ constructor(ast) {
22
+ super(ast);
23
+ this.type = "omdBinaryExpressionNode";
24
+ if (!ast.args?.length || ast.args.length < 2) {
25
+ throw new Error(`omdBinaryExpressionNode requires an AST node with at least 2 arguments. Received: ${JSON.stringify(ast)}`);
26
+ }
27
+
28
+ this.left = this.createExpressionNode(ast.args[0]);
29
+ this.argumentNodeList.left = this.left;
30
+
31
+ this.operation = this.parseOperation();
32
+ this.op = !ast.implicit ? this.createOperatorNode(ast) : null; // Gerard: Implicit multiplication does not include operator node
33
+ this.isImplicit = ast.implicit || false;
34
+
35
+ this.right = this.createExpressionNode(ast.args[1]);
36
+ this.argumentNodeList.right = this.right;
37
+
38
+ // Convert explicit multiplication to implicit based on configuration
39
+ if (this.op && (ast.op === '*' || ast.op === '×' || ast.fn === 'multiply')) {
40
+ // Check if we should reorder operands (e.g., x*2 -> 2x)
41
+ if (this._shouldReorderMultiplication(this.left, this.right)) {
42
+ // Swap left and right operands
43
+ const temp = this.left;
44
+ this.left = this.right;
45
+ this.right = temp;
46
+
47
+ // Update argument list
48
+ this.argumentNodeList.left = this.left;
49
+ this.argumentNodeList.right = this.right;
50
+
51
+ // Update AST args as well for consistency
52
+ const tempArg = this.astNodeData.args[0];
53
+ this.astNodeData.args[0] = this.astNodeData.args[1];
54
+ this.astNodeData.args[1] = tempArg;
55
+ }
56
+
57
+ if (this._shouldUseImplicitMultiplication(this.left, this.right)) {
58
+ // Remove the operator node to treat as implicit multiplication
59
+ this.removeChild(this.op);
60
+ this.op = null;
61
+
62
+ // Mark AST as implicit for cloning/mathjs compatibility
63
+ this.astNodeData.implicit = true;
64
+ }
65
+ }
66
+ }
67
+
68
+ parseOperation() {
69
+ return this.astNodeData.fn;
70
+ }
71
+
72
+ createExpressionNode(ast) {
73
+ let NodeType = getNodeForAST(ast);
74
+ let child = new NodeType(ast);
75
+ this.addChild(child);
76
+
77
+ return child;
78
+ }
79
+
80
+ createOperatorNode(ast) {
81
+ let opAst = { type: "OperatorNode", op: ast.op };
82
+ if (ast.operatorProvenance) {
83
+ opAst.provenance = ast.operatorProvenance;
84
+ }
85
+ let op = new omdOperatorNode(opAst);
86
+ this.addChild(op);
87
+
88
+ return op;
89
+ }
90
+
91
+ computeDimensions() {
92
+ // Compute dimensions for all children first
93
+ this.left.computeDimensions();
94
+ this.op?.computeDimensions();
95
+ this.right.computeDimensions();
96
+
97
+ // Gerard: Calculate dimensions based on child dimensions
98
+ let sumChildrenWidth = this.left.width + this.right.width + (this.op !== null ? this.op.width : 0);
99
+ let maxChildrenHeight = Math.max(this.left.height, this.right.height);
100
+
101
+ // Gerard: Add spacing between op and operands, if there is an op (not implicit)
102
+ let padding = 0 * this.getFontSize() / this.getRootFontSize(); // Gerard: Vertical padding, should scale with fontSize
103
+ let spacedWidth = sumChildrenWidth + this.getSpacing() * 2;
104
+ let spacedHeight = maxChildrenHeight + padding;
105
+
106
+ this.setWidthAndHeight(spacedWidth, spacedHeight);
107
+ }
108
+
109
+ updateLayout() {
110
+ const spacing = this.getSpacing();
111
+ const maxBaseline = Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
112
+ let xOffset = 0;
113
+
114
+ // Position children so their baselines align.
115
+ this.left.updateLayout();
116
+ this.left.setPosition(xOffset, maxBaseline - this.left.getAlignmentBaseline());
117
+ xOffset += this.left.width + spacing;
118
+
119
+ if (this.op !== null) {
120
+ // Center the operator on the max baseline.
121
+ const opBaseline = this.op.getAlignmentBaseline();
122
+ this.op.updateLayout();
123
+ this.op.setPosition(xOffset, maxBaseline - opBaseline);
124
+ xOffset += this.op.width + spacing;
125
+ }
126
+
127
+ this.right.updateLayout();
128
+ this.right.setPosition(xOffset, maxBaseline - this.right.getAlignmentBaseline());
129
+ }
130
+
131
+ /**
132
+ * The alignment baseline for a binary expression should be the baseline of its operator,
133
+ * adjusted for its position within the expression's bounding box.
134
+ * @override
135
+ * @returns {number} The y-coordinate for alignment.
136
+ */
137
+ getAlignmentBaseline() {
138
+ if (this.op) {
139
+ // The true baseline is the baseline of the operator, plus the operator's y-offset.
140
+ const maxChildBaseline = Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
141
+ const op_yOffset = maxChildBaseline - this.op.getAlignmentBaseline();
142
+ return op_yOffset + this.op.getAlignmentBaseline();
143
+ }
144
+ // If there's no operator (implicit multiplication), the expression's baseline
145
+ // is the shared alignment baseline of its children.
146
+ return Math.max(this.left.getAlignmentBaseline(), this.right.getAlignmentBaseline());
147
+ }
148
+
149
+ clone() {
150
+ // Create a new node. The constructor will add a backRect and temporary children.
151
+ const tempAst = { type: 'OperatorNode', op: '+', args: [{type: 'ConstantNode', value: 1}, {type: 'ConstantNode', value: 1}] };
152
+ const clone = new omdBinaryExpressionNode(tempAst);
153
+
154
+ // Keep the backRect, but get rid of the temporary children.
155
+ const backRect = clone.backRect;
156
+ clone.removeAllChildren();
157
+ clone.addChild(backRect);
158
+
159
+ // Manually clone the real children to ensure the entire tree has correct provenance.
160
+ clone.left = this.left.clone();
161
+ clone.addChild(clone.left);
162
+
163
+ if (this.op) {
164
+ clone.op = this.op.clone();
165
+ clone.addChild(clone.op);
166
+ } else {
167
+ clone.op = null;
168
+ }
169
+
170
+ clone.right = this.right.clone();
171
+ clone.addChild(clone.right);
172
+
173
+ // Rebuild the argument list, operation, and copy AST data.
174
+ clone.argumentNodeList = { left: clone.left, right: clone.right };
175
+ clone.operation = this.operation;
176
+ clone.astNodeData = JSON.parse(JSON.stringify(this.astNodeData));
177
+
178
+ // The crucial step: link the clone to its origin.
179
+ clone.provenance.push(this.id);
180
+
181
+ return clone;
182
+ }
183
+
184
+ // Gerard: Calculator horizontal spacing depending on whether op is implicit and scaling with font size
185
+ getSpacing() {
186
+ if (this.op === null) return 0;
187
+
188
+ return 6 * this.getFontSize() / this.getRootFontSize();
189
+ }
190
+
191
+ /**
192
+ * Determines if implicit multiplication should be used based on configuration
193
+ * @private
194
+ * @param {omdNode} left - Left operand
195
+ * @param {omdNode} right - Right operand
196
+ * @returns {boolean}
197
+ */
198
+ _shouldUseImplicitMultiplication(left, right) {
199
+ // If global implicit multiplication is disabled, use traditional logic
200
+ if (!useImplicitMultiplication()) {
201
+ return this._isCoefficientMultiplication(left, right);
202
+ }
203
+
204
+ // Check specific combinations based on configuration
205
+ const leftType = this._getNodeCategory(left);
206
+ const rightType = this._getNodeCategory(right);
207
+
208
+ const combinationKey = `${leftType}-${rightType}`;
209
+ return this._getImplicitMultiplicationSetting(combinationKey);
210
+ }
211
+
212
+ /**
213
+ * Gets the implicit multiplication setting for a given combination
214
+ * Converts kebab-case combination keys to camelCase config keys
215
+ * @private
216
+ * @param {string} combinationKey - The combination key (e.g., 'constant-variable')
217
+ * @returns {boolean} Whether implicit multiplication should be used
218
+ */
219
+ _getImplicitMultiplicationSetting(combinationKey) {
220
+ // Handle special reordering cases that map to the same config setting
221
+ const reorderingMappings = {
222
+ 'variable-constant': 'constant-variable', // x*3 -> 3x (reordered)
223
+ 'parenthesis-constant': 'constant-parenthesis' // (x+1)*3 -> 3(x+1) (reordered)
224
+ };
225
+
226
+ // Use the mapping if it exists, otherwise use the original key
227
+ const normalizedKey = reorderingMappings[combinationKey] || combinationKey;
228
+
229
+ // Convert kebab-case to camelCase (e.g., 'constant-variable' -> 'constantVariable')
230
+ const camelCaseKey = normalizedKey.replace(/-([a-z])/g, (match, letter) => letter.toUpperCase());
231
+
232
+ return useImplicitMultiplication(camelCaseKey);
233
+ }
234
+
235
+ /**
236
+ * Categorizes a node for implicit multiplication rules
237
+ * @private
238
+ * @param {omdNode} node - The node to categorize
239
+ * @returns {string} The category name
240
+ */
241
+ _getNodeCategory(node) {
242
+ if (node instanceof omdConstantNode && node.isConstant()) {
243
+ return 'constant';
244
+ }
245
+ if (node instanceof omdVariableNode) {
246
+ return 'variable';
247
+ }
248
+ if (node instanceof omdPowerNode) {
249
+ return 'power';
250
+ }
251
+ if (node instanceof omdParenthesisNode) {
252
+ return 'parenthesis';
253
+ }
254
+ return 'other';
255
+ }
256
+
257
+ /**
258
+ * Determines if multiplication operands should be reordered for conventional display
259
+ * (e.g., x*2 -> 2x, y*3 -> 3y)
260
+ * @private
261
+ * @param {omdNode} left - Left operand
262
+ * @param {omdNode} right - Right operand
263
+ * @returns {boolean} True if operands should be swapped
264
+ */
265
+ _shouldReorderMultiplication(left, right) {
266
+ const leftType = this._getNodeCategory(left);
267
+ const rightType = this._getNodeCategory(right);
268
+
269
+ // Reorder if: left is non-constant and right is constant
270
+ // Examples: x*2 -> 2x, y*3 -> 3y, (x+1)*5 -> 5(x+1)
271
+ return (leftType !== 'constant' && rightType === 'constant');
272
+ }
273
+
274
+ /**
275
+ * Determines if the multiplication represents a coefficient (e.g. 3*x -> 3x)
276
+ * @private
277
+ * @param {omdNode} left - Left operand
278
+ * @param {omdNode} right - Right operand
279
+ * @returns {boolean}
280
+ */
281
+ _isCoefficientMultiplication(left, right) {
282
+ const leftIsNumericConstant = left instanceof omdConstantNode && left.isConstant();
283
+ const rightIsVariableLike = (
284
+ right instanceof omdVariableNode ||
285
+ right instanceof omdPowerNode ||
286
+ right instanceof omdParenthesisNode
287
+ );
288
+ return leftIsNumericConstant && rightIsVariableLike;
289
+ }
290
+
291
+ /**
292
+ * Converts the omdBinaryExpressionNode to a math.js AST node.
293
+ * @returns {Object} A math.js-compatible AST node.
294
+ */
295
+ toMathJSNode() {
296
+ const astNode = {
297
+ type: 'OperatorNode',
298
+ op: this.op ? this.op.opName : '*',
299
+ fn: this.operation,
300
+ args: [this.left.toMathJSNode(), this.right.toMathJSNode()],
301
+ implicit: !this.op,
302
+ id: this.id,
303
+ provenance: this.provenance
304
+ };
305
+
306
+ // Add a clone method to maintain compatibility with math.js's expectations.
307
+ astNode.clone = function() {
308
+ const clonedNode = { ...this };
309
+ clonedNode.args = this.args.map(arg => arg.clone());
310
+ return clonedNode;
311
+ };
312
+ return astNode;
313
+ }
314
+
315
+ /**
316
+ * Converts the binary expression node to a string.
317
+ * @returns {string} The string representation of the expression.
318
+ */
319
+ toString() {
320
+ const leftStr = this.left.toString();
321
+ const rightStr = this.right.toString();
322
+ const opStr = this.op ? ` ${this.op.toString()} ` : '';
323
+
324
+ // Handle implicit multiplication case (no operator)
325
+ if (!this.op) {
326
+ return `${leftStr}${rightStr}`;
327
+ }
328
+
329
+ // Wrap children in parentheses if their precedence is lower than this node's.
330
+ const finalLeft = this.left.needsParentheses && this.left.needsParentheses(this.op.value) ? `(${leftStr})` : leftStr;
331
+ const finalRight = this.right.needsParentheses && this.right.needsParentheses(this.op.value) ? `(${rightStr})` : rightStr;
332
+
333
+ return `${finalLeft}${opStr}${finalRight}`;
334
+ }
335
+
336
+ /**
337
+ * Evaluates the expression by recursively evaluating children.
338
+ * @param {Object} variables - A map of variable names to their numeric values.
339
+ * @returns {number} The result of the expression.
340
+ */
341
+ evaluate(variables = {}) {
342
+ const operations = {
343
+ 'add': (a, b) => a + b,
344
+ 'subtract': (a, b) => a - b,
345
+ 'multiply': (a, b) => a * b,
346
+ 'divide': (a, b) => {
347
+ if (b === 0) throw new Error("Division by zero.");
348
+ return a / b;
349
+ }
350
+ };
351
+
352
+ const leftVal = this.left.evaluate(variables);
353
+ const rightVal = this.right.evaluate(variables);
354
+
355
+ if (this.isImplicit) {
356
+ return leftVal * rightVal;
357
+ }
358
+
359
+ const func = operations[this.operation];
360
+
361
+ if (func) {
362
+ return func(leftVal, rightVal);
363
+ }
364
+
365
+ throw new Error(`Unsupported operation for evaluation: ${this.operation}`);
366
+ }
367
+
368
+ /**
369
+ * Determine if parentheses are needed based on parent operator
370
+ * @returns {boolean} Whether parentheses are required
371
+ */
372
+ needsParentheses() {
373
+ const parent = this.parent;
374
+ if (!parent || !(parent instanceof omdBinaryExpressionNode)) {
375
+ return false;
376
+ }
377
+
378
+ const thisOp = this.op ? this.op.opName : '*';
379
+ const parentOp = parent.op ? parent.op.opName : '*';
380
+
381
+ const precedence = {
382
+ '+': 1,
383
+ '-': 1,
384
+ '*': 2,
385
+ '×': 2,
386
+ '/': 2,
387
+ '÷': 2,
388
+ '^': 3
389
+ };
390
+
391
+ const thisPrecedence = precedence[thisOp] || 0;
392
+ const parentPrecedence = precedence[parentOp] || 0;
393
+
394
+ // Need parentheses if this operation has lower precedence than parent
395
+ if (thisPrecedence < parentPrecedence) {
396
+ return true;
397
+ }
398
+
399
+ // Special case: subtraction and division are left-associative
400
+ // So (a - b) - c needs parentheses on the right: a - (b - c)
401
+ if (thisPrecedence === parentPrecedence && parent.right === this) {
402
+ if (thisOp === '-' || thisOp === '/' || thisOp === '÷') {
403
+ return true;
404
+ }
405
+ }
406
+
407
+ return false;
408
+ }
409
+
410
+ /**
411
+ * Helper method to get function name from operator
412
+ * @private
413
+ * @param {string} op - The operator symbol
414
+ * @returns {string} The function name
415
+ */
416
+ getFunctionForOperator(op) {
417
+ const opMap = {
418
+ '+': 'add',
419
+ '-': 'subtract',
420
+ '*': 'multiply',
421
+ '×': 'multiply',
422
+ '/': 'divide',
423
+ '÷': 'divide'
424
+ };
425
+ return opMap[op] || 'unknown';
426
+ }
427
+
428
+ setHighlight(highlightOn = true, color = omdColor.highlightColor) {
429
+ if (this.isExplainHighlighted) return; // Respect the lock
430
+
431
+ // Highlight/unhighlight the binary expression itself
432
+ super.setHighlight(highlightOn, color);
433
+
434
+ // Also highlight/unhighlight the children (left operand, operator, right operand)
435
+ if (this.left && typeof this.left.setHighlight === 'function') {
436
+ this.left.setHighlight(highlightOn, color);
437
+ }
438
+ if (this.op && typeof this.op.setHighlight === 'function') {
439
+ this.op.setHighlight(highlightOn, color);
440
+ }
441
+ if (this.right && typeof this.right.setHighlight === 'function') {
442
+ this.right.setHighlight(highlightOn, color);
443
+ }
444
+ }
445
+
446
+ clearProvenanceHighlights() {
447
+ super.clearProvenanceHighlights();
448
+
449
+ // Also clear highlights from children
450
+ if (this.left && typeof this.left.clearProvenanceHighlights === 'function') {
451
+ this.left.clearProvenanceHighlights();
452
+ }
453
+ if (this.op && typeof this.op.clearProvenanceHighlights === 'function') {
454
+ this.op.clearProvenanceHighlights();
455
+ }
456
+ if (this.right && typeof this.right.clearProvenanceHighlights === 'function') {
457
+ this.right.clearProvenanceHighlights();
458
+ }
459
+ }
460
460
  }