Class: Plurimath::Math::Function::Int

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

Constant Summary collapse

FUNCTION = 
{
  name: "integral",
  first_value: "lower limit",
  second_value: "upper limit",
  third_value: "integrand",
}.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 = {}) ⇒ Int

Returns a new instance of Int.



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



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

def options
  @options
end

Instance Method Details

#==(object) ⇒ Object 



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

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

#intent_names ⇒ Object 



135
136
137
 
# File 'lib/plurimath/math/function/int.rb', line 135

def intent_names
  { name: ":integral" }
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/plurimath/math/function/int.rb', line 131

def is_nary_function?
  true
end

#line_breaking(obj) ⇒ Object 



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

def line_breaking(obj)
  parameter_one&.line_breaking(obj)
  if obj.value_exist?
    int = Int.new(Utility.filter_values(obj.value), parameter_two,
                  parameter_three)
    int.hide_function_name = true
    obj.update(int)
    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

#nary_array(display_style, options:) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/plurimath/math/function/int.rb', line 118

def nary_array(display_style, options:)
  symbol = hide_function_name ? "" : "∫"
  [
    narypr(symbol, 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),
  ]
end

#to_asciimath(options:) ⇒ Object 



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

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
  "int#{first_value}#{second_value} #{parameter_three&.to_asciimath(options: options)}".strip
end

#to_latex(options:) ⇒ Object 



40
41
42
43
44
 
# File 'lib/plurimath/math/function/int.rb', line 40

def to_latex(options:)
  first_value = "_{#{parameter_one.to_latex(options: options)}}" if parameter_one
  second_value = "^{#{parameter_two.to_latex(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 



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
72
73
74
75
 
# File 'lib/plurimath/math/function/int.rb', line 46

def to_mathml_without_math_tag(intent, options:)
  base_element = (Utility.ox_element("mo") << invert_unicode_symbols.to_s)
  return base_element unless any_value_exist?

  msubsup_tag = Utility.ox_element("msubsup")
  Utility.update_nodes(
    msubsup_tag,
    [
      base_element,
      validate_mathml_tag(parameter_one, intent, options: options),
      validate_mathml_tag(parameter_two, intent, options: options),
    ],
  )
  msubsup_tag = masked_tag(msubsup_tag) if self.options&.key?(:mask)
  return msubsup_tag if parameter_three.nil?

  mrow = ox_element("mrow")
  Utility.update_nodes(
    mrow,
    [
      msubsup_tag,
      wrap_mrow(
        parameter_three&.to_mathml_without_math_tag(intent,
                                                    options: options), intent
      ),
    ].flatten.compact,
  )
  intentify(mrow, intent, func_name: :naryand,
                          intent_name: intent_names[:name])
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



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

def to_omml_without_math_tag(display_style, options:)
  if any_value_exist?
    nary = Utility.ox_element("nary", namespace: "m")
    Utility.update_nodes(nary,
                         nary_array(display_style, options: options))
    [nary]
  else
    r_tag = Utility.ox_element("r", namespace: "m")
    t_tag = Utility.ox_element("t", namespace: "m")
    r_tag << (t_tag << "&#x222b;")
    [r_tag]
  end
end

#to_unicodemath(options:) ⇒ Object 



91
92
93
94
95
96
97
98
 
# File 'lib/plurimath/math/function/int.rb', line 91

def to_unicodemath(options:)
  first_value = sub_value(options: options) if parameter_one
  second_value = sup_value(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