Class: Plurimath::Math::Function::Base

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

Constant Summary collapse

FUNCTION = 
{
  name: "subscript",
  first_value: "base",
  second_value: "script",
}.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_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, #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, #updated_object_values, #validate_function_formula, #validate_mathml_fields, #variable_value, #variables

Constructor Details

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

Returns a new instance of Base.



15
16
17
18
19
20
 
# File 'lib/plurimath/math/function/base.rb', line 15

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.



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

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



22
23
24
25
 
# File 'lib/plurimath/math/function/base.rb', line 22

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

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/plurimath/math/function/base.rb', line 111

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

#line_breaking(obj) ⇒ Object 



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

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

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

#new_nary_function(fourth_value) ⇒ Object 



107
108
109
 
# File 'lib/plurimath/math/function/base.rb', line 107

def new_nary_function(fourth_value)
  Nary.new(parameter_one, parameter_two, nil, fourth_value)
end

#to_asciimath(options:) ⇒ Object 



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

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

#to_html(options:) ⇒ Object 



54
55
56
57
58
 
# File 'lib/plurimath/math/function/base.rb', line 54

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

#to_latex(options:) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/plurimath/math/function/base.rb', line 47

def to_latex(options:)
  first_value  = parameter_one.to_latex(options: options) if parameter_one
  first_value  = "{#{first_value}}" if parameter_one.is_a?(Formula)
  second_value = parameter_two.to_latex(options: options) if parameter_two
  "#{first_value}_{#{second_value}}"
end

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/plurimath/math/function/base.rb', line 36

def to_mathml_without_math_tag(intent, options:)
  tag_name = Utility::MUNDER_CLASSES.include?(parameter_one&.class_name) ? "under" : "sub"
  sub_tag = Utility.ox_element("m#{tag_name}")
  mathml_value = []
  mathml_value << validate_mathml_fields(parameter_one, intent,
                                         options: options)
  mathml_value << validate_mathml_fields(parameter_two, intent,
                                         options: options)
  Utility.update_nodes(sub_tag, mathml_value)
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/plurimath/math/function/base.rb', line 60

def to_omml_without_math_tag(display_style, options:)
  ssub_element  = Utility.ox_element("sSub", namespace: "m")
  subpr_element = Utility.ox_element("sSubPr", namespace: "m")
  subpr_element << Utility.pr_element("ctrl", true, namespace: "m")
  Utility.update_nodes(
    ssub_element,
    [
      subpr_element,
      omml_parameter(parameter_one, display_style, tag_name: "e",
                                                   options: options),
      omml_parameter(parameter_two, display_style, tag_name: "sub",
                                                   options: options),
    ],
  )
  [ssub_element]
end

#to_unicodemath(options:) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/plurimath/math/function/base.rb', line 77

def to_unicodemath(options:)
  first_value = parameter_one.to_unicodemath(options: options) if parameter_one
  second_value = if parameter_two.is_a?(self.class)
                   "_#{size_overrides}#{parameter_two.to_unicodemath(options: options)}"
                 elsif parameter_two&.mini_sized?
                   parameter_two.to_unicodemath(options: options)
                 elsif parameter_two.nil?
                   "()"
                 else
                   "_#{size_overrides}#{unicodemath_parens(parameter_two,
                                                           options: options)}"
                 end
  "#{first_value}#{second_value}"
end