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::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_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

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

Returns a new instance of Oint.



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

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.



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

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



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

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

#intent_names ⇒ Object 



151
152
153
 
# File 'lib/plurimath/math/function/oint.rb', line 151

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

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/plurimath/math/function/oint.rb', line 147

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/plurimath/math/function/oint.rb', line 129

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 



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

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

#to_latex(options:) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/plurimath/math/function/oint.rb', line 39

def to_latex(options:)
  if parameter_one
    first_value = "_#{latex_wrapped(parameter_one,
                                    options: options)}"
  end
  if parameter_two
    second_value = "^#{latex_wrapped(parameter_two,
                                     options: options)}"
  end
  "\\#{class_name}#{first_value}#{second_value} #{parameter_three&.to_latex(options: options)}".strip
end

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/plurimath/math/function/oint.rb', line 51

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 any_value_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 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/plurimath/math/function/oint.rb', line 89

def to_omml_without_math_tag(display_style, options:)
  if any_value_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 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/plurimath/math/function/oint.rb', line 114

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