Class: Plurimath::Math::Function::Prod

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

Constant Summary collapse

FUNCTION = 
{
  name: "prod",
  first_value: "subscript",
  second_value: "supscript",
}.freeze

Constants inherited from Core

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

Methods inherited from Core

#ascii_fields_to_print, #class_name, #cloned_objects, #common_math_zone_conversion, #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, #insert_t_tag, #invert_unicode_symbols, #is_binary_function?, #is_nary_symbol?, #is_ternary_function?, #is_unary?, #latex_fields_to_print, #linebreak, #mathml_fields_to_print, #mini_sized?, #omml_fields_to_print, #omml_nodes, #omml_parameter, #omml_tag_name, #ox_element, #r_element, #replacable_values, #result, #separate_table, #set, #tag_name, #unicodemath_parens, #updated_object_values, #validate_function_formula, #validate_mathml_fields, #variable_value, #variables

Constructor Details

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

Returns a new instance of Prod.



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

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.



9
10
11
 
# File 'lib/plurimath/math/function/prod.rb', line 9

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



24
25
26
 
# File 'lib/plurimath/math/function/prod.rb', line 24

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

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/plurimath/math/function/prod.rb', line 122

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/plurimath/math/function/prod.rb', line 107

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

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

#nary_attr_value ⇒ Object 



103
104
105
 
# File 'lib/plurimath/math/function/prod.rb', line 103

def nary_attr_value
  "∏"
end

#nary_values(display_style) ⇒ Object 



94
95
96
97
98
99
100
101
 
# File 'lib/plurimath/math/function/prod.rb', line 94

def nary_values(display_style)
  [
    narypr(hide_function_name ? "" : nary_attr_value),
    omml_parameter(parameter_one, display_style, tag_name: "sub"),
    omml_parameter(parameter_two, display_style, tag_name: "sup"),
    omml_parameter(parameter_three, display_style, tag_name: "e"),
  ]
end

#to_asciimath ⇒ Object 



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

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

#to_html ⇒ Object 



73
74
75
76
77
 
# File 'lib/plurimath/math/function/prod.rb', line 73

def to_html
  first_value = "<sub>#{parameter_one.to_html}</sub>" if parameter_one
  second_value = "<sup>#{parameter_two.to_html}</sup>" if parameter_two
  "<i>&prod;</i>#{first_value}#{second_value}"
end

#to_latex ⇒ Object 



34
35
36
37
38
 
# File 'lib/plurimath/math/function/prod.rb', line 34

def to_latex
  first_value = "_{#{parameter_one.to_latex}}" if parameter_one
  second_value = "^{#{parameter_two.to_latex}}" if parameter_two
  "\\prod#{first_value}#{second_value} #{parameter_three&.to_latex}".strip
end

#to_mathml_without_math_tag ⇒ Object 



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

def to_mathml_without_math_tag
  first_value = ox_element("mo")
  first_value << invert_unicode_symbols.to_s unless hide_function_name
  if parameter_one || parameter_two
    tag_name = if parameter_two && parameter_one
                 "underover"
               else
                 parameter_one ? "under" : "over"
               end
    value_array = [
      first_value,
      parameter_one&.to_mathml_without_math_tag,
      parameter_two&.to_mathml_without_math_tag,
    ]
    munderover_tag = ox_element("m#{tag_name}")
    Utility.update_nodes(
      munderover_tag,
      value_array,
    )
    return munderover_tag if parameter_three.nil?

    Utility.update_nodes(
      Utility.ox_element("mrow"),
      [
        munderover_tag,
        parameter_three&.to_mathml_without_math_tag,
      ].flatten.compact,
    )
  else
    first_value
  end
end

#to_omml_without_math_tag(display_style) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/plurimath/math/function/prod.rb', line 79

def to_omml_without_math_tag(display_style)
  return r_element("&#x220f;", rpr_tag: false) unless all_values_exist?

  nary = Utility.ox_element("nary", namespace: "m")
  Utility.update_nodes(nary, nary_values(display_style))
  [nary]
end

#to_unicodemath ⇒ Object 



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

def to_unicodemath
  first_value = sub_value if parameter_one
  second_value = sup_value if parameter_two
  mask = options&.dig(:mask) if options&.key?(:mask)
  "#{nary_attr_value}#{mask}#{first_value}#{second_value}#{naryand_value(parameter_three)}"
end