Class: Plurimath::Math::Function::Overset

Inherits:
BinaryFunction show all
Defined in:
lib/plurimath/math/function/overset.rb

Constant Summary collapse

FUNCTION = 
{
  name: "overset",
  first_value: "base",
  second_value: "supscript",
}.freeze

Constants inherited from Core

Core::ALL_PARAMETERS, Core::REPLACABLES

Instance Attribute Summary collapse

Attributes inherited from BinaryFunction

#hide_function_name, #parameter_one, #parameter_two

Instance Method Summary collapse

Methods inherited from BinaryFunction

#==, #all_values_exist?, #any_value_exist?, #to_asciimath, #to_asciimath_math_zone, #to_html, #to_latex, #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

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

Returns a new instance of Overset.



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

def initialize(
  parameter_one = nil,
  parameter_two = nil,
  options = {})
  super(parameter_one, parameter_two)
  @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/overset.rb', line 9

def options
  @options
end

Instance Method Details

#accent=(value) ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/plurimath/math/function/overset.rb', line 84

def accent=(value)
  return unless value

  @options ||= {}
  @options[:accent] = value
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/plurimath/math/function/overset.rb', line 80

def is_nary_function?
  parameter_two.is_nary_function? || parameter_two.is_nary_symbol?
end

#line_breaking(obj) ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/plurimath/math/function/overset.rb', line 68

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

#new_nary_function(fourth_value) ⇒ Object 



76
77
78
 
# File 'lib/plurimath/math/function/overset.rb', line 76

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

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/plurimath/math/function/overset.rb', line 25

def to_mathml_without_math_tag(intent, options:)
  value_array = [
    validate_mathml_fields(parameter_two, intent, options: options),
    validate_mathml_fields(parameter_one, intent, options: options),
  ]
  Utility.update_nodes(
    ox_element("mover", attributes: self.options),
    value_array,
  )
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/plurimath/math/function/overset.rb', line 36

def to_omml_without_math_tag(display_style, options:)
  if !display_style
    power = Power.new(parameter_one, parameter_two)
    return power.to_omml_without_math_tag(display_style, options: options)
  end

  limupp   = Utility.ox_element("limUpp", namespace: "m")
  limupppr = Utility.ox_element("limUppPr", namespace: "m")
  limupppr << Utility.pr_element("ctrl", true, namespace: "m")
  Utility.update_nodes(
    limupp,
    [
      limupppr,
      # Overset preserves Plurimath's source argument order across
      # formats; OMML uses this mapping to avoid remapping fields during
      # MathML/UnicodeMath/OMML round-trips.
      omml_parameter(parameter_one, display_style, tag_name: "e", options: options),
      omml_parameter(parameter_two, display_style, tag_name: "lim", options: options),
    ],
  )
  [limupp]
end

#to_unicodemath(options:) ⇒ Object 



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

def to_unicodemath(options:)
  return "#{unicodemath_parens(parameter_two, options: options)}#{unicodemath_field_value(parameter_one)}" if unicode_accent?(parameter_one)
  return "#{unicodemath_field_value(parameter_one)}#{parameter_two.to_unicodemath(options: options)}" if unicode_accent?(parameter_two)
  return "#{parameter_one.to_unicodemath(options: options)}#{unicodemath_parens(parameter_two, options: options)}" if horizontal_brackets?
  return "#{parameter_two.to_unicodemath(options: options)}^#{unicodemath_parens(parameter_one, options: options)}" if unicode_classes_accent?(parameter_two)

  "#{unicodemath_parens(parameter_two, options: options)}┴#{unicodemath_parens(parameter_one, options: options)}" if parameter_one || parameter_two
end