Class: Plurimath::Math::Function::Underset

Inherits:
BinaryFunction show all
Includes:
Plurimath::Mathml::Utility
Defined in:
lib/plurimath/math/function/underset.rb

Constant Summary collapse

FUNCTION = 
{
  name: "underscript",
  first_value: "underscript value",
  second_value: "base expression",
}.freeze

Constants included from Plurimath::Mathml::Utility::FormulaTransformation

Plurimath::Mathml::Utility::FormulaTransformation::CONDITIONAL_COMMON_UNARY_FUNCTIONS, Plurimath::Mathml::Utility::FormulaTransformation::SYMBOL_UPDATABLE_FUNCTIONS

Constants inherited from Core

Core::ALL_PARAMETERS, Core::REPLACABLES

Instance Attribute Summary collapse

Attributes included from Plurimath::Mathml::Utility

#temp_mathml_order

Attributes inherited from BinaryFunction

#hide_function_name, #parameter_one, #parameter_two

Instance Method Summary collapse

Methods included from Plurimath::Mathml::Utility

#accent=, #accentunder=, #bevelled=, #clear_temp_order, #linebreak=, #linebreakstyle=, #linethickness=, #maligngroup_value=, #malignmark_value=, #mathvariant=, #menclose_value=, #merror_value=, #mfenced_value=, #mfrac_value=, #mfraction_value=, #mglyph_value=, #mi_value=, #mlabeledtr_value=, #mlongdiv_value=, #mmultiscripts_value=, #mn_value=, #mo_value=, #mover_value=, #mpadded_value=, #mphantom_value=, #mroot_value=, #mrow_value=, #ms_value=, #mscarries_value=, #mscarry_value=, #msgroup_value=, #msline_value=, #mspace_value=, #msqrt_value=, #msrow_value=, #mstack_value=, #mstyle_value=, #msub_value=, #msubsup_value=, #msup_value=, #mtable_value=, #mtext_value=, #munder_value=, #munderover_value=, #none_value=, #notation=, #semantics_value=

Methods included from Plurimath::Mathml::Utility::EmptyDefinedMethods

#accent, #accentunder, #align, #align=, #alignmentscope, #alignmentscope=, #annotation, #background, #background=, #bevelled, #charalign, #charalign=, #charspacing, #charspacing=, #close, #close=, #color, #color=, #columnalign, #columnalign=, #columnlines, #columnlines=, #columnspacing, #columnspacing=, #columnspan, #columnspan=, #columnwidth, #columnwidth=, #crossout, #crossout=, #decimalpoint, #decimalpoint=, #denomalign, #denomalign=, #depth, #depth=, #dir, #dir=, #displaystyle, #displaystyle=, #edge, #edge=, #equalcolumns, #equalcolumns=, #equalrows, #equalrows=, #fence, #fence=, #fontfamily, #fontfamily=, #fontsize, #fontsize=, #fontstyle, #fontstyle=, #fontweight, #fontweight=, #form, #form=, #frame, #frame=, #framespacing, #framespacing=, #groupalign, #groupalign=, #height, #height=, #id, #indentalign, #indentalign=, #indentalignfirst, #indentalignfirst=, #indentalignlast, #indentalignlast=, #indentshift, #indentshift=, #indentshiftfirst, #indentshiftfirst=, #indentshiftlast, #indentshiftlast=, #indenttarget, #indenttarget=, #infixlinebreakstyle, #infixlinebreakstyle=, #intent, #intent=, #largeop, #largeop=, #leftoverhang, #leftoverhang=, #length, #length=, #linebreak, #linebreakmultchar, #linebreakmultchar=, #linebreakstyle, #lineleading, #lineleading=, #linethickness, #location, #location=, #longdivstyle, #longdivstyle=, #lquote, #lquote=, #lspace, #lspace=, #maligngroup_value, #malignmark, #malignmark=, #malignmark_value, #mathbackground, #mathbackground=, #mathbackgroundcolor, #mathbackgroundcolor=, #mathcolor, #mathcolor=, #mathsize, #mathsize=, #mathvariant, #maxsize, #maxsize=, #mediummathspace, #mediummathspace=, #menclose_value, #merror_value, #mfenced_value, #mfrac_value, #mfraction_value, #mglyph_value, #mi_value, #minlabelspacing, #minlabelspacing=, #minsize, #minsize=, #mlabeledtr_value, #mlongdiv_value, #mmultiscripts_value, #mn_value, #mo_value, #movablelimits, #movablelimits=, #mover_value, #mpadded_value, #mphantom_value, #mprescripts_value, #mprescripts_value=, #mroot_value, #mrow_value, #ms_value, #mscarries_value, #mscarry_value, #msgroup_value, #msline_value, #mslinethickness, #mslinethickness=, #mspace_value, #msqrt_value, #msrow_value, #mstack_value, #mstyle_value, #msub_value, #msubsup_value, #msup_value, #mtable_value, #mtd_value, #mtext_value, #mtr_value, #munder_value, #munderover_value, #none_value, #notation, #numalign, #numalign=, #open, #open=, #position, #position=, #rightoverhang, #rightoverhang=, #rowalign, #rowalign=, #rowlines, #rowlines=, #rowspacing, #rowspacing=, #rowspan, #rowspan=, #rquote, #rquote=, #rspace, #rspace=, #scriptlevel, #scriptlevel=, #scriptminsize, #scriptminsize=, #scriptsizemultiplier, #scriptsizemultiplier=, #selection, #selection=, #semantics_value, #separator, #separator=, #separators, #separators=, #shift, #shift=, #side, #side=, #stackalign, #stackalign=, #stretchy, #stretchy=, #subscriptshift, #subscriptshift=, #superscriptshift, #superscriptshift=, #symmetric, #symmetric=, #thickmathspace, #thickmathspace=, #thinmathspace, #thinmathspace=, #valign, #valign=, #verythickmathspace, #verythickmathspace=, #verythinmathspace, #verythinmathspace=, #veryverythickmathspace, #veryverythickmathspace=, #veryverythinmathspace, #veryverythinmathspace=, #width, #width=

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, #mini_sized?, #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 = {}) ⇒ Underset

Returns a new instance of Underset.



20
21
22
23
24
25
26
 
# File 'lib/plurimath/math/function/underset.rb', line 20

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.



12
13
14
 
# File 'lib/plurimath/math/function/underset.rb', line 12

def options
  @options
end

Instance Method Details

#content=(value) ⇒ Object 



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

def content=(value)
  if no_content_in?(Array(value))
    delete_all_text
  else
    new_val = Array(value).map do |val|
      validate_symbols(val) unless val.strip.empty?
    end
    validate_text_order(new_val)
  end
  update_temp_mathml_values(@temp_mathml_order)
end

#element_order=(value) ⇒ Object 



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

def element_order=(value)
  @temp_mathml_order = validated_order(
    value,
    rejectable_array: ["comment"]
  )
end

#is_nary_function? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/plurimath/math/function/underset.rb', line 89

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

#line_breaking(obj) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/plurimath/math/function/underset.rb', line 71

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 



85
86
87
 
# File 'lib/plurimath/math/function/underset.rb', line 85

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

#to_mathml_without_math_tag(intent, options:) ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/plurimath/math/function/underset.rb', line 35

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("munder", attributes: self.options), value_array)
end

#to_omml_without_math_tag(display_style, options:) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/plurimath/math/function/underset.rb', line 43

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

  limlow   = Utility.ox_element("limLow", namespace: "m")
  limlowpr = Utility.ox_element("limLowPr", namespace: "m")
  limlowpr << Utility.pr_element("ctrl", true, namespace: "m")
  Utility.update_nodes(
    limlow,
    [
      limlowpr,
      omml_parameter(parameter_one, display_style, tag_name: "e", options: options),
      omml_parameter(parameter_two, display_style, tag_name: "lim", options: options),
    ],
  )
  [limlow]
end

#to_unicodemath(options:) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/plurimath/math/function/underset.rb', line 63

def to_unicodemath(options:)
  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)
  return "#{unicodemath_parens(parameter_two, options: options)}#{unicodemath_field_value(parameter_one)}" if unicode_accent?(parameter_one)

  "#{unicodemath_parens(parameter_two, options: options)}┬#{parameter_one.to_unicodemath(options: options)}"
end