Class: Plurimath::Math::Function::Sum

Inherits:
TernaryFunction show all
Defined in:
lib/plurimath/math/function/sum.rb

Constant Summary collapse

FUNCTION = 
{
  name: "summation",
  first_value: "subscript",
  second_value: "supscript",
  third_value: "term",
}.freeze

Constants inherited from Core

Core::ALL_PARAMETERS, Core::REPLACABLES

Instance Attribute Summary collapse

Attributes inherited from TernaryFunction

#hide_function_name, #parameter_one, #parameter_three, #parameter_two

Instance Method Summary collapse

Methods inherited from TernaryFunction

#all_values_exist?, #any_value_exist?, #to_asciimath_math_zone, #to_latex_math_zone, #to_mathml_math_zone, #to_omml_math_zone, #to_unicodemath_math_zone

Methods inherited from Core

#ascii_fields_to_print, #class_name, #cloned_objects, #close?, #common_math_zone_conversion, descendants, #divide_operator?, #dump_mathml, #dump_nodes, #dump_omml, #dump_ox_nodes, #empty_tag, #extract_class_name_from_text, #extractable?, #filtered_values, #font_style_t_tag, #get, #gsub_spacing, inherited, #insert_t_tag, #invert_unicode_symbols, #is_binary_function?, #is_mrow?, #is_mstyle?, #is_nary_symbol?, #is_ternary_function?, #is_unary?, #latex_fields_to_print, #linebreak?, #mathml_fields_to_print, #mathml_nodes, #mini_sized?, #minus_operator?, #msty_tag_with_attrs, #multiply_operator?, #nary_intent_name, #omml_fields_to_print, #omml_nodes, #omml_parameter, #open?, #operator?, #ox_element, #paren?, #plus_operator?, #power_operator?, #pretty_print_instance_variables, #prime_unicode?, #r_element, #replacable_values, #reserved_constant, #result, #separate_table, #set, #symbol?, #tag_name, #to_ms_value, #unicodemath_fields_to_print, #unicodemath_parens, #updated_object_values, #validate_function_formula, #validate_mathml_fields, #variable_name, #variable_value, #variables

Constructor Details

#initialize(parameter_one = nil, parameter_two = nil, parameter_three = nil, options = {}) ⇒ Sum

Returns a new instance of Sum.



26
27
28
29
30
31
32
 
# File 'lib/plurimath/math/function/sum.rb', line 26

def initialize(parameter_one = nil,
               parameter_two = nil,
               parameter_three = nil,
               options = {})
  super(parameter_one, parameter_two, parameter_three)
  @options = options unless options&.empty?
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



7
8
9
 
# File 'lib/plurimath/math/function/sum.rb', line 7

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



34
35
36
 
# File 'lib/plurimath/math/function/sum.rb', line 34

def ==(object)
  super && object.options == options
end

#evaluate(evaluator) ⇒ Object 



16
17
18
19
20
21
22
23
24
 
# File 'lib/plurimath/math/function/sum.rb', line 16

def evaluate(evaluator)
  if parameter_one.nil? || parameter_two.nil? || parameter_three.nil?
    evaluator.unsupported(self)
  end

  Evaluation::Iteration
    .new(evaluator, parameter_one, parameter_two, parameter_three)
    .accumulate(0, :+)
end

#intent_names ⇒ Object 



157
158
159
 
# File 'lib/plurimath/math/function/sum.rb', line 157

def intent_names
  { name: ":sum" }
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/plurimath/math/function/sum.rb', line 153

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



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

def line_breaking(obj)
  parameter_one&.line_breaking(obj)
  if obj.value_exist?
    sum = self.class.new(Utility.filter_values(obj.value),
                         parameter_two, parameter_three)
    sum.hide_function_name = true
    obj.update(sum)
    self.parameter_two = nil
    self.parameter_three = nil
    return
  end

  parameter_three&.line_breaking(obj)
  if obj.value_exist?
    obj.update(Utility.filter_values(obj.value))
  end
end

#nary_attr_value ⇒ Object 



131
132
133
 
# File 'lib/plurimath/math/function/sum.rb', line 131

def nary_attr_value(**)
  "∑"
end

#omml_tag_name ⇒ Object 



127
128
129
 
# File 'lib/plurimath/math/function/sum.rb', line 127

def omml_tag_name
  "undOvr"
end

#to_asciimath(options:) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/plurimath/math/function/sum.rb', line 38

def to_asciimath(options:)
  if parameter_one
    first_value = "_#{wrapped(parameter_one,
                              options: options)}"
  end
  if parameter_two
    second_value = "^#{wrapped(parameter_two,
                               options: options)}"
  end
  "sum#{first_value}#{second_value} #{parameter_three&.to_asciimath(options: options)}".strip
end

#to_html(options:) ⇒ Object 



87
88
89
90
91
 
# File 'lib/plurimath/math/function/sum.rb', line 87

def to_html(options:)
  first_value = "<sub>#{parameter_one.to_html(options: options)}</sub>" if parameter_one
  second_value = "<sup>#{parameter_two.to_html(options: options)}</sup>" if parameter_two
  "<i>&sum;</i>#{first_value}#{second_value}"
end

#to_latex(options:) ⇒ Object 



50
51
52
53
54
 
# File 'lib/plurimath/math/function/sum.rb', line 50

def to_latex(options:)
  first_value = "_{#{parameter_one.to_latex(options: options)}}" if parameter_one
  second_value = "^{#{parameter_two.to_latex(options: options)}}" if parameter_two
  "\\sum#{first_value}#{second_value} #{parameter_three&.to_latex(options: options)}".strip
end

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



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
 
# File 'lib/plurimath/math/function/sum.rb', line 56

def to_mathml_without_math_tag(intent, options:)
  first_value = ox_element("mo")
  first_value << invert_unicode_symbols.to_s unless hide_function_name
  return first_value unless any_value_exist?

  munderover_tag = Utility.update_nodes(
    sum_tag,
    [
      first_value,
      parameter_one&.to_mathml_without_math_tag(intent,
                                                options: options),
      parameter_two&.to_mathml_without_math_tag(intent,
                                                options: options),
    ],
  )
  return munderover_tag if parameter_three.nil?

  mrow = ox_element("mrow")
  Utility.update_nodes(
    mrow,
    [
      munderover_tag,
      wrap_mrow(
        parameter_three&.to_mathml_without_math_tag(intent,
                                                    options: options), intent
      ),
    ],
  )
  ternary_intentify(mrow, intent)
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/plurimath/math/function/sum.rb', line 108

def to_omml_without_math_tag(display_style, options:)
  return r_element("&#x2211;", rpr_tag: false) unless any_value_exist?

  nary = Utility.ox_element("nary", namespace: "m")
  Utility.update_nodes(
    nary,
    [
      narypr(hide_function_name ? "" : "∑"),
      omml_parameter(parameter_one, display_style, tag_name: "sub",
                                                   options: options),
      omml_parameter(parameter_two, display_style, tag_name: "sup",
                                                   options: options),
      omml_parameter(parameter_three, display_style, tag_name: "e",
                                                     options: options),
    ],
  )
  [nary]
end

#to_unicodemath(options:) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/plurimath/math/function/sum.rb', line 93

def to_unicodemath(options:)
  if parameter_one
    first_value = "_#{unicodemath_parens(parameter_one,
                                         options: options)}"
  end
  if parameter_two
    second_value = "^#{unicodemath_parens(parameter_two,
                                          options: options)}"
  end
  mask = self.options&.dig(:mask) if self.options&.key?(:mask)
  "∑#{mask}#{first_value}#{second_value}#{naryand_value(
    parameter_three, options: options
  )}"
end