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::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, #common_math_zone_conversion, descendants, #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, #mini_sized?, #nary_intent_name, #omml_fields_to_print, #omml_nodes, #omml_parameter, #omml_tag_name, #ox_element, #paren?, #pretty_print_instance_variables, #prime_unicode?, #r_element, #replacable_values, #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_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

#intent_names ⇒ Object 



119
120
121
 
# File 'lib/plurimath/math/function/prod.rb', line 119

def intent_names
  { name: ":product" }
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/plurimath/math/function/prod.rb', line 115

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/plurimath/math/function/prod.rb', line 100

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 



96
97
98
 
# File 'lib/plurimath/math/function/prod.rb', line 96

def nary_attr_value(**)
  "∏"
end

#nary_values(display_style, options:) ⇒ Object 



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

def nary_values(display_style, options:)
  [
    narypr(hide_function_name ? "" : nary_attr_value),
    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),
  ]
end

#to_asciimath(options:) ⇒ Object 



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

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

#to_html(options:) ⇒ Object 



66
67
68
69
70
 
# File 'lib/plurimath/math/function/prod.rb', line 66

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>&prod;</i>#{first_value}#{second_value}"
end

#to_latex(options:) ⇒ Object 



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

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
  "\\prod#{first_value}#{second_value} #{parameter_three&.to_latex(options: options)}".strip
end

#to_mathml_without_math_tag(intent, options:) ⇒ 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
 
# File 'lib/plurimath/math/function/prod.rb', line 40

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 all_values_exist?

  munderover_tag = Utility.update_nodes(
    prod_tag_name,
    [
      first_value,
      parameter_one&.to_mathml_without_math_tag(intent, options: options),
      parameter_two&.to_mathml_without_math_tag(intent, options: options),
    ],
  )
  return ternary_intentify(munderover_tag, intent) 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),
    ].flatten.compact,
  )
  ternary_intentify(mrow, intent)
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



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

def to_omml_without_math_tag(display_style, options:)
  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, options: options))
  [nary]
end

#to_unicodemath(options:) ⇒ Object 



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

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