Class: Plurimath::Math::Function::Oint

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

Constant Summary collapse

FUNCTION = 
{
  name: "contour integral",
  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_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_nary_symbol?, #is_ternary_function?, #is_unary?, #latex_fields_to_print, #linebreak, #mathml_fields_to_print, #mini_sized?, #nary_attr_value, #nary_intent_name, #omml_fields_to_print, #omml_nodes, #omml_parameter, #omml_tag_name, #ox_element, #prime_unicode?, #r_element, #replacable_values, #result, #separate_table, #set, #tag_name, #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 = {}) ⇒ Oint

Returns a new instance of Oint.



16
17
18
19
20
21
22
 
# File 'lib/plurimath/math/function/oint.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/oint.rb', line 9

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



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

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

#intent_names ⇒ Object 



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

def intent_names
  { name: ":contour integral"}
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/plurimath/math/function/oint.rb', line 118

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



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

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

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

#to_asciimath(options:) ⇒ Object 



28
29
30
31
32
 
# File 'lib/plurimath/math/function/oint.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
  "oint#{first_value}#{second_value} #{parameter_three&.to_asciimath(options: options)}".strip
end

#to_latex(options:) ⇒ Object 



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

def to_latex(options:)
  first_value = "_#{latex_wrapped(parameter_one, options: options)}" if parameter_one
  second_value = "^#{latex_wrapped(parameter_two, options: options)}" if parameter_two
  "\\#{class_name}#{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
65
66
67
68
69
70
71
 
# File 'lib/plurimath/math/function/oint.rb', line 40

def to_mathml_without_math_tag(intent, options:)
  mo_tag = ox_element("mo")
  mo_tag << invert_unicode_symbols.to_s unless hide_function_name
  return mo_tag unless all_values_exist?

  tag_name = if parameter_one && parameter_two
               "subsup"
             else
               parameter_one ? "sub" : "sup"
             end
  oint_tag = ox_element("m#{tag_name}")
  Utility.update_nodes(
    oint_tag,
    [
      mo_tag,
      parameter_one&.to_mathml_without_math_tag(intent, options: options),
      parameter_two&.to_mathml_without_math_tag(intent, options: options),
    ],
  )
  return ternary_intentify(oint_tag, intent) unless parameter_three

  ternary_intentify(
    Utility.update_nodes(
      ox_element("mrow"),
      [
        oint_tag,
        wrap_mrow(parameter_three&.to_mathml_without_math_tag(intent, options: options), intent),
      ],
    ),
    intent,
  )
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/plurimath/math/function/oint.rb', line 73

def to_omml_without_math_tag(display_style, options:)
  if all_values_exist?
    nary = Utility.ox_element("nary", namespace: "m")
    Utility.update_nodes(
      nary,
      [
        narypr((hide_function_name ? "" : "∮"), function_type: "subSup"),
        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),
      ],
    )
    [nary]
  else
    r_tag = Utility.ox_element("r", namespace: "m")
    t_tag = Utility.ox_element("t", namespace: "m")
    r_tag << (t_tag << "&#x222e;")
    [r_tag]
  end
end

#to_unicodemath(options:) ⇒ Object 



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

def to_unicodemath(options:)
  first_value = "_#{unicodemath_parens(parameter_one, options: options)}" if parameter_one
  second_value = "^#{unicodemath_parens(parameter_two, options: options)}" if parameter_two
  mask = self.options&.dig(:mask) if self.options&.key?(:mask)
  "∮#{mask}#{first_value}#{second_value}#{naryand_value(parameter_three, options: options)}"
end