Class: Plurimath::Math::Function::Underover

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

Constant Summary collapse

FUNCTION = 
{
  name: "UnderOver",
  first_value: "base",
  second_value: "Under",
  third_value: "Over",
}.freeze

Constants inherited from Core

Core::ALL_PARAMETERS, Core::REPLACABLES

Instance Attribute Summary

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?, #initialize, #to_asciimath_math_zone, #to_html, #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, #mathml_nodes, #mini_sized?, #msty_tag_with_attrs, #nary_attr_value, #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

This class inherits a constructor from Plurimath::Math::Function::TernaryFunction

Instance Method Details

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/plurimath/math/function/underover.rb', line 108

def is_nary_function?
  parameter_one.is_nary_function? || parameter_one.is_nary_symbol?
end

#line_breaking(obj) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plurimath/math/function/underover.rb', line 80

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

  parameter_two.line_breaking(obj)
  if obj.value_exist?
    obj.update(
      Underover.new(nil, Utility.filter_values(obj.value),
                    parameter_three),
    )
    self.parameter_two = nil
    self.parameter_three = nil
  end
end

#new_nary_function(fourth_value) ⇒ Object 



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

def new_nary_function(fourth_value)
  Nary.new(parameter_one, parameter_two, parameter_three, fourth_value,
           { type: "undOvr" })
end

#to_asciimath(options:) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/plurimath/math/function/underover.rb', line 14

def to_asciimath(options:)
  if parameter_one
    first_value = first_field_wrap(parameter_one,
                                   options: options)
  end
  if parameter_two
    second_value = "_#{wrapped(parameter_two,
                               options: options)}"
  end
  if parameter_three
    third_value = "^#{wrapped(parameter_three,
                              options: options)}"
  end
  "#{first_value}#{second_value}#{third_value}"
end

#to_latex(options:) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/plurimath/math/function/underover.rb', line 30

def to_latex(options:)
  if parameter_one
    first_value = first_field_wrap(parameter_one, type: "latex",
                                                  options: options)
  end
  if parameter_two
    second_value = "_#{wrapped(parameter_two, type: 'latex',
                                              options: options)}"
  end
  if parameter_three
    third_value = "^#{wrapped(parameter_three, type: 'latex',
                                               options: options)}"
  end
  "#{first_value}#{second_value}#{third_value}"
end

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/plurimath/math/function/underover.rb', line 46

def to_mathml_without_math_tag(intent, options:)
  Utility.update_nodes(
    ox_element("m#{class_name}"),
    [
      validate_mathml_fields(parameter_one, intent, options: options),
      validate_mathml_fields(parameter_two, intent, options: options),
      validate_mathml_fields(parameter_three, intent, options: options),
    ],
  )
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/plurimath/math/function/underover.rb', line 57

def to_omml_without_math_tag(display_style, options:)
  if !display_style
    power_base = PowerBase.new(parameter_one, parameter_two,
                               parameter_three)
    return power_base.to_omml_without_math_tag(display_style,
                                               options: options)
  end

  underover(display_style, options: options)
end

#to_unicodemath(options:) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plurimath/math/function/underover.rb', line 68

def to_unicodemath(options:)
  if parameter_two
    sub_value = "┬#{unicodemath_parens(parameter_two,
                                       options: options)}"
  end
  if parameter_three
    sup_value = "┴#{unicodemath_parens(parameter_three,
                                       options: options)}"
  end
  "#{parameter_one&.to_unicodemath(options: options)}#{sub_value}#{sup_value}"
end