Class: Plurimath::Math::Formula

Inherits:
Core
  • Object
show all
Defined in:
lib/plurimath/math/formula.rb

Constant Summary collapse

MATH_ZONE_TYPES = 
%i[
  omml
  latex
  mathml
  asciimath
  unicodemath
].freeze
POWER_BASE_CLASSES = 
%w[powerbase power base].freeze
DERIVATIVE_CONSTS = 
[
  "𝑑",
  "ⅅ",
  "ⅆ",
  "d",
].freeze

Constants inherited from Core

Core::REPLACABLES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Core

#ascii_fields_to_print, #class_name, #common_math_zone_conversion, descendants, #dump_mathml, #dump_nodes, #dump_omml, #dump_ox_nodes, #empty_tag, #extractable?, #filtered_values, #font_style_t_tag, #get, #gsub_spacing, inherited, #insert_t_tag, #invert_unicode_symbols, #is_binary_function?, #is_nary_function?, #is_nary_symbol?, #is_ternary_function?, #is_unary?, #latex_fields_to_print, #linebreak, #mathml_fields_to_print, #nary_intent_name, #omml_fields_to_print, #omml_nodes, #omml_parameter, #omml_tag_name, #ox_element, #prime_unicode?, #r_element, #replacable_values, #result, #separate_table, #set, #tag_name, #unicodemath_fields_to_print, #unicodemath_parens, #updated_object_values, #validate_mathml_fields, #variable_value, #variables

Constructor Details

#initialize(value = [], left_right_wrapper = true, display_style: true, input_string: nil, unitsml: false) ⇒ Formula

Returns a new instance of Formula.



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/plurimath/math/formula.rb', line 23

def initialize(
  value = [],
  left_right_wrapper = true,
  display_style: true,
  input_string: nil,
  unitsml: false
)
  @value = value.is_a?(Array) ? value : [value]
  left_right_wrapper = false if @value.first.is_a?(Function::Left)
  @left_right_wrapper = left_right_wrapper
  @displaystyle = boolean_display_style(display_style)
  @unitsml = unitsml if unitsml
end

Instance Attribute Details

#displaystyle ⇒ Object

Returns the value of attribute displaystyle.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def displaystyle
  @displaystyle
end

#input_string ⇒ Object

Returns the value of attribute input_string.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def input_string
  @input_string
end

#left_right_wrapper ⇒ Object

Returns the value of attribute left_right_wrapper.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def left_right_wrapper
  @left_right_wrapper
end

#unitsml ⇒ Object

Returns the value of attribute unitsml.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def unitsml
  @unitsml
end

#unitsml_xml ⇒ Object

Returns the value of attribute unitsml_xml.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def unitsml_xml
  @unitsml_xml
end

#value ⇒ Object

Returns the value of attribute value.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def value
  @value
end

Instance Method Details

#==(object) ⇒ Object 



37
38
39
40
41
42
 
# File 'lib/plurimath/math/formula.rb', line 37

def ==(object)
  object.respond_to?(:value) &&
    object.respond_to?(:left_right_wrapper) &&
    object.value == value &&
    object.left_right_wrapper == left_right_wrapper
end

#cloned_objects ⇒ Object 



252
253
254
255
256
257
 
# File 'lib/plurimath/math/formula.rb', line 252

def cloned_objects
  cloned_obj = value.map(&:cloned_objects)
  formula = self.class.new(cloned_obj)
  formula.left_right_wrapper = @left_right_wrapper
  formula
end

#extract_class_name_from_text ⇒ Object 



230
231
232
233
234
 
# File 'lib/plurimath/math/formula.rb', line 230

def extract_class_name_from_text
  return unless value.length < 2 && value.first.is_a?(Function::Text)

  value.first.parameter_one
end

#insert(values) ⇒ Object 



291
292
293
 
# File 'lib/plurimath/math/formula.rb', line 291

def insert(values)
  update(Array(value) + values)
end

#intent_names ⇒ Object 



300
301
302
303
304
305
 
# File 'lib/plurimath/math/formula.rb', line 300

def intent_names
  {
    partial_derivative: ":partial-derivative",
    derivative: ":derivative",
  }
end

#line_breaked_mathml(display_style, intent, options:) ⇒ Object 



76
77
78
79
80
 
# File 'lib/plurimath/math/formula.rb', line 76

def line_breaked_mathml(display_style, intent, options:)
  new_line_support.map do |formula|
    formula.to_mathml(display_style: display_style, intent: intent, formatter: options[:formatter])
  end.join
end

#line_breaking(obj) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/plurimath/math/formula.rb', line 267

def line_breaking(obj)
  if result.size > 1
    breaked_result = result.first.last.omml_line_break(result)
    update(Array(breaked_result.shift))
    obj.update(breaked_result.flatten)
    reprocess_value(obj)
    return
  end

  value.each.with_index(1) do |object, index|
    object.line_breaking(obj)
    break obj.insert(value.slice!(index..value.size)) if obj.value_exist?
  end
end

#mathml_content(intent, options:) ⇒ Object 



93
94
95
96
97
 
# File 'lib/plurimath/math/formula.rb', line 93

def mathml_content(intent, options:)
  nodes = value.map { |val| val.to_mathml_without_math_tag(intent, options: options) }
  intent_post_processing(nodes, intent) if intent
  nodes
end

#mini_sized? ⇒ Boolean

Returns:

  • (Boolean) 


296
297
298
 
# File 'lib/plurimath/math/formula.rb', line 296

def mini_sized?
  true if value&.first&.mini_sized?
end

#nary_attr_value(options:) ⇒ Object 



236
237
238
 
# File 'lib/plurimath/math/formula.rb', line 236

def nary_attr_value(options:)
  value.first.nary_attr_value(options: Hash.new(options))
end

#new_line_support(array = []) ⇒ Object 



259
260
261
262
263
264
265
 
# File 'lib/plurimath/math/formula.rb', line 259

def new_line_support(array = [])
  cloned = cloned_objects
  obj = self.class.new
  cloned.line_breaking(obj)
  array << cloned
  obj.value_exist? ? obj.new_line_support(array) : array
end

#omml_attrs ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/plurimath/math/formula.rb', line 113

def omml_attrs
  {
    "xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
    "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
    "xmlns:mo": "http://schemas.microsoft.com/office/mac/office/2008/main",
    "xmlns:mv": "urn:schemas-microsoft-com:mac:vml",
    "xmlns:o": "urn:schemas-microsoft-com:office:office",
    "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
    "xmlns:v": "urn:schemas-microsoft-com:vml",
    "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
    "xmlns:w10": "urn:schemas-microsoft-com:office:word",
    "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
    "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
    "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
    "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
    "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
    "xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
    "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
    "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
    "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
  }
end

#omml_content(display_style, options:) ⇒ Object 



154
155
156
 
# File 'lib/plurimath/math/formula.rb', line 154

def omml_content(display_style, options:)
  value&.map { |val| val.insert_t_tag(display_style, options: options) }
end

#reprocess_value(obj) ⇒ Object 



282
283
284
285
286
287
288
289
 
# File 'lib/plurimath/math/formula.rb', line 282

def reprocess_value(obj)
  new_obj = self.class.new([])
  self.line_breaking(new_obj)
  if new_obj.value_exist?
    obj.value.insert(0, Function::Linebreak.new)
    obj.value.insert(0, self.class.new(new_obj.value))
  end
end

#to_asciimath(formatter: nil, options: nil) ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/plurimath/math/formula.rb', line 44

def to_asciimath(formatter: nil, options: nil)
  options ||= { formatter: formatter }
  value.map { |val| val.to_asciimath(options: options) }.join(" ")
rescue
  parse_error!(:asciimath)
end

#to_asciimath_math_zone(spacing = "", last = false, indent = true, options:) ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/plurimath/math/formula.rb', line 195

def to_asciimath_math_zone(spacing = "", last = false, indent = true, options:)
  filtered_values(value, lang: :asciimath).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_asciimath_math_zone(new_space(spacing, indent), last, indent, options: options)
  end
end

#to_display(type = nil, formatter: nil) ⇒ Object 



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
 
# File 'lib/plurimath/math/formula.rb', line 169

def to_display(type = nil, formatter: nil)
  options = { formatter: formatter }
  return type_error! unless MATH_ZONE_TYPES.include?(type.downcase.to_sym)

  math_zone = case type
              when :asciimath
                "  |_ \"#{to_asciimath(options: options)}\"\n#{to_asciimath_math_zone("     ", options: options).join}"
              when :latex
                "  |_ \"#{to_latex(options: options)}\"\n#{to_latex_math_zone("     ", options: options).join}"
              when :mathml
                mathml = to_mathml(formatter: formatter).gsub(/\n\s*/, "")
                math_display = to_mathml_math_zone("     ", options: options).join
                "  |_ \"#{mathml}\"\n#{math_display}"
              when :omml
                omml = to_omml.gsub(/\n\s*/, "")
                omml_display = to_omml_math_zone("     ", display_style: displaystyle, options: options).join
                "  |_ \"#{omml}\"\n#{omml_display}"
              when :unicodemath
                "  |_ \"#{to_unicodemath(options: options)}\"\n#{to_unicodemath_math_zone("     ", options: options).join}"
              end
  <<~MATHZONE.sub(/\n$/, "")
  |_ Math zone
  #{math_zone}
  MATHZONE
end

#to_html(formatter: nil, options: nil) ⇒ Object 



106
107
108
109
110
111
 
# File 'lib/plurimath/math/formula.rb', line 106

def to_html(formatter: nil, options: nil)
  options ||= { formatter: formatter }
  value&.map { |val| val.to_html(options: options) }&.join(" ")
rescue
  parse_error!(:html)
end

#to_latex(formatter: nil, options: nil) ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/plurimath/math/formula.rb', line 99

def to_latex(formatter: nil, options: nil)
  options ||= { formatter: formatter }
  value.map { |val| val.to_latex(options: options) }.join(" ")
rescue
  parse_error!(:latex)
end

#to_latex_math_zone(spacing = "", last = false, indent = true, options:) ⇒ Object 



202
203
204
205
206
207
 
# File 'lib/plurimath/math/formula.rb', line 202

def to_latex_math_zone(spacing = "", last = false, indent = true, options:)
  filtered_values(value, lang: :latex).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_latex_math_zone(new_space(spacing, indent), last, indent, options: options)
  end
end

#to_mathml(intent: false, formatter: nil, unitsml_xml: nil, split_on_linebreak: false, display_style: displaystyle) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/plurimath/math/formula.rb', line 51

def to_mathml(
  intent: false,
  formatter: nil,
  unitsml_xml: nil,
  split_on_linebreak: false,
  display_style: displaystyle
)
  options = { formatter: formatter, unitsml_xml: unitsml_xml }
  return line_breaked_mathml(display_style, intent, options: options) if split_on_linebreak

  math_attrs = {
    xmlns: "http://www.w3.org/1998/Math/MathML",
    display: "block",
  }
  style_attrs = { displaystyle: boolean_display_style(display_style) }
  math  = ox_element("math", attributes: math_attrs)
  style = ox_element("mstyle", attributes: style_attrs)
  Utility.update_nodes(style, mathml_content(intent, options: options))
  Utility.update_nodes(math, [style])
  unitsml_post_processing(math.nodes, math)
  dump_nodes(math, indent: 2)
rescue
  parse_error!(:mathml)
end

#to_mathml_math_zone(spacing = "", last = false, indent = true, options:) ⇒ Object 



209
210
211
212
213
214
 
# File 'lib/plurimath/math/formula.rb', line 209

def to_mathml_math_zone(spacing = "", last = false, indent = true, options:)
  filtered_values(value, lang: :mathml, options: options).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_mathml_math_zone(new_space(spacing, indent), last, indent, options: options)
  end
end

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/plurimath/math/formula.rb', line 82

def to_mathml_without_math_tag(intent, options:)
  return mathml_content(intent, options: options) unless left_right_wrapper

  mathml_value = mathml_content(intent, options: options)
  attributes = intent_attribute(mathml_value) if intent
  mrow = ox_element("mrow", attributes: attributes)
  mrow[:unitsml] = true if unitsml
  mathml_value += wrapped_unitsml_xml(mrow) if unitsml_xml && options[:unitsml_xml]
  Utility.update_nodes(mrow, mathml_value)
end

#to_omml(display_style: displaystyle, split_on_linebreak: false, formatter: nil) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/plurimath/math/formula.rb', line 136

def to_omml(display_style: displaystyle, split_on_linebreak: false, formatter: nil)
  objects = split_on_linebreak ? new_line_support : [self]
  options = { formatter: formatter }
  para_element = Utility.ox_element("oMathPara", attributes: omml_attrs, namespace: "m")
  objects.each.with_index(1) do |object, index|
    para_element << Utility.update_nodes(
      Utility.ox_element("oMath", namespace: "m"),
      object.omml_content(boolean_display_style(display_style), options: options),
    )
    next if objects.length == index

    para_element << omml_br_tag
  end
  dump_nodes(para_element, indent: 2)
rescue
  parse_error!(:omml)
end

#to_omml_math_zone(spacing = "", last = false, indent = true, display_style:, options:) ⇒ Object 



216
217
218
219
220
221
 
# File 'lib/plurimath/math/formula.rb', line 216

def to_omml_math_zone(spacing = "", last = false, indent = true, display_style:, options:)
  filtered_values(value, lang: :omml).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_omml_math_zone(new_space(spacing, indent), last, indent, display_style: display_style, options: options)
  end
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



158
159
160
 
# File 'lib/plurimath/math/formula.rb', line 158

def to_omml_without_math_tag(display_style, options:)
  omml_content(display_style, options: options)
end

#to_unicodemath(formatter: nil, options: nil) ⇒ Object 



162
163
164
165
166
167
 
# File 'lib/plurimath/math/formula.rb', line 162

def to_unicodemath(formatter: nil, options: nil)
  options ||= { formatter: formatter }
  Utility.html_entity_to_unicode(unicodemath_value(options: options)).gsub(/\s\/\s/, "/")
rescue
  parse_error!(:unicodemath)
end

#to_unicodemath_math_zone(spacing = "", last = false, indent = true, options:) ⇒ Object 



223
224
225
226
227
228
 
# File 'lib/plurimath/math/formula.rb', line 223

def to_unicodemath_math_zone(spacing = "", last = false, indent = true, options:)
  filtered_values(value, lang: :unicodemath).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_unicodemath_math_zone(new_space(spacing, indent), last, indent, options: options)
  end
end

#update(object) ⇒ Object 



248
249
250
 
# File 'lib/plurimath/math/formula.rb', line 248

def update(object)
  self.value = Array(object)
end

#validate_function_formula ⇒ Object 



240
241
242
 
# File 'lib/plurimath/math/formula.rb', line 240

def validate_function_formula
  (value.none?(Function::Left) || value.none?(Function::Right))
end

#value_exist? ⇒ Boolean

Returns:

  • (Boolean) 


244
245
246
 
# File 'lib/plurimath/math/formula.rb', line 244

def value_exist?
  value && !value.empty?
end