Class: Plurimath::Utility

Inherits:
Object
  • Object
show all
Defined in:
lib/plurimath/utility.rb,
lib/plurimath/utility/intent_encoding.rb

Direct Known Subclasses

IntentEncoding

Defined Under Namespace

Classes: IntentEncoding

Constant Summary collapse

UNICODE_REGEX =
%r{&#x[a-zA-Z0-9]+;}
FONT_STYLES =
{
  "double-struck": Math::Function::FontStyle::DoubleStruck,
  "sans-serif-bold-italic": Math::Function::FontStyle::SansSerifBoldItalic,
  "sans-serif-italic": Math::Function::FontStyle::SansSerifItalic,
  "bold-sans-serif": Math::Function::FontStyle::BoldSansSerif,
  "sans-serif": Math::Function::FontStyle::SansSerif,
  "bold-fraktur": Math::Function::FontStyle::BoldFraktur,
  "bold-italic": Math::Function::FontStyle::BoldItalic,
  "bold-script": Math::Function::FontStyle::BoldScript,
  mbfitsans: Math::Function::FontStyle::SansSerifBoldItalic,
  monospace: Math::Function::FontStyle::Monospace,
  mathfrak: Math::Function::FontStyle::Fraktur,
  mitsans: Math::Function::FontStyle::SansSerifItalic,
  mbfsans: Math::Function::FontStyle::BoldSansSerif,
  mbffrak: Math::Function::FontStyle::BoldFraktur,
  mathcal: Math::Function::FontStyle::Script,
  fraktur: Math::Function::FontStyle::Fraktur,
  mbfscr: Math::Function::FontStyle::BoldScript,
  mathbb: Math::Function::FontStyle::DoubleStruck,
  double: Math::Function::FontStyle::DoubleStruck,
  mathtt: Math::Function::FontStyle::Monospace,
  mathsf: Math::Function::FontStyle::SansSerif,
  mathrm: Math::Function::FontStyle::Normal,
  textrm: Math::Function::FontStyle::Normal,
  italic: Math::Function::FontStyle::Italic,
  mathit: Math::Function::FontStyle::Italic,
  textit: Math::Function::FontStyle::Italic,
  mathbf: Math::Function::FontStyle::Bold,
  textbf: Math::Function::FontStyle::Bold,
  script: Math::Function::FontStyle::Script,
  normal: Math::Function::FontStyle::Normal,
  mbfit: Math::Function::FontStyle::BoldItalic,
  msans: Math::Function::FontStyle::SansSerif,
  mfrak: Math::Function::FontStyle::Fraktur,
  mscr: Math::Function::FontStyle::Script,
  bold: Math::Function::FontStyle::Bold,
  bbb: Math::Function::FontStyle::DoubleStruck,
  Bbb: Math::Function::FontStyle::DoubleStruck,
  mtt: Math::Function::FontStyle::Monospace,
  cal: Math::Function::FontStyle::Script,
  mit: Math::Function::FontStyle::Italic,
  mup: Math::Function::FontStyle::Normal,
  mbf: Math::Function::FontStyle::Bold,
  sf: Math::Function::FontStyle::SansSerif,
  tt: Math::Function::FontStyle::Monospace,
  fr: Math::Function::FontStyle::Fraktur,
  rm: Math::Function::FontStyle::Normal,
  cc: Math::Function::FontStyle::Script,
  ii: Math::Function::FontStyle::Italic,
  bb: Math::Function::FontStyle::Bold,
  bf: Math::Function::FontStyle::Bold,
}.freeze
ALIGNMENT_LETTERS =
{
  c: "center",
  r: "right",
  l: "left",
}.freeze
UNARY_CLASSES =
%w[
  arccos
  arcsin
  arctan
  liminf
  limsup
  right
  sech
  sinh
  tanh
  cosh
  coth
  csch
  left
  max
  min
  sec
  sin
  sup
  deg
  det
  dim
  exp
  gcd
  glb
  lub
  lcm
  ker
  tan
  cos
  cot
  csc
  ln
  lg
].freeze
MUNDER_CLASSES =
%w[
  ubrace
  obrace
  right
  max
  min
].freeze
PARENTHESIS =
{
  "〈": "〉",
  "⌊": "⌋",
  "⌈": "⌉",
  "‖": "‖",
  "{": "}",
  "[": "]",
  "|": "|",
  "(": ")",
  "{": "}",
  "[": "]",
}.freeze
TEXT_CLASSES =
%w[
  symbol
  number
  text
].freeze
TABLE_SUPPORTED_ATTRS =
%i[
  columnlines
  rowlines
  frame
].freeze
MPADDED_ATTRS =
%i[
  height
  depth
  width
].freeze
MGLYPH_ATTRS =
%i[
  height
  width
  index
  alt
  src
].freeze
UNICODEMATH_MENCLOSE_FUNCTIONS =
{
  underline: "bottom",
  underbar: "bottom",
  longdiv: "longdiv",
  xcancel: "updiagonalstrike downdiagonalstrike",
  bcancel: "updiagonalstrike",
  ellipse: "circle",
  circle: "circle",
  cancel: "downdiagonalstrike",
  rrect: "roundedbox",
  rect: "box",
}.freeze
MASK_CLASSES =
{
  1 => "top",
  2 => "bottom",
  4 => "left",
  8 => "right",
  16 => "horizontalstrike",
  32 => "verticalstrike",
  64 => "downdiagonalstrike",
  128 => "updiagonalstrike",
}.freeze
HTML_ENTITIES =
HTMLEntities.new

Class Method Summary collapse

Class Method Details

.accent_value(accent, lang:, function: false) ⇒ Object



894
895
896
897
898
899
900
901
902
# File 'lib/plurimath/utility.rb', line 894

def accent_value(accent, lang:, function: false)
  if accent[:accent_symbols]
    symbols_class(
      UnicodeMath::Constants::ACCENT_SYMBOLS[accent[:accent_symbols].to_sym] || accent[:accent_symbols], lang: lang
    )
  else
    accent[:first_value] || filter_values(accent[:prime_accent_symbols])
  end
end

.all_symbols_classes(lang) ⇒ Object



307
308
309
# File 'lib/plurimath/utility.rb', line 307

def all_symbols_classes(lang)
  symbols_hash(lang).merge(parens_hash(lang))
end

.asciimath_symbol_object(value, lang: :asciimath) ⇒ Object



648
649
650
651
652
653
654
655
# File 'lib/plurimath/utility.rb', line 648

def asciimath_symbol_object(value, lang: :asciimath)
  return if value.nil?

  symbols = symbols_hash(lang)
  return symbols[value&.to_s].new if symbols.key?(value&.to_s)

  symbol_object(value&.to_s, lang: lang)
end

.attr_is_accent(attrs, value) ⇒ Object



551
552
553
554
555
556
557
558
559
# File 'lib/plurimath/utility.rb', line 551

def attr_is_accent(attrs, value)
  if value.last.is_a?(Math::Function::UnaryFunction)
    value.last.parameter_one = value.shift if value.length > 1
    value.last.attributes = attrs.transform_values do |v|
      YAML.safe_load(v)
    end
  end
  value
end

.attr_is_function(attrs, value) ⇒ Object



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/plurimath/utility.rb', line 561

def attr_is_function(attrs, value)
  case attrs
  when Math::Function::Fenced
    attrs.parameter_two = value.compact
    attrs
  when Math::Function::FontStyle
    attrs.parameter_one = filter_values(value)
    attrs
  when Math::Function::Color
    color_value = filter_values(value)
    if attrs.parameter_two
      attrs.parameter_two.parameter_one = color_value
    else
      attrs.parameter_two = color_value
    end
    attrs
  end
end

.base_is_prime?(base) ⇒ Boolean

Returns:

  • (Boolean)


1016
1017
1018
1019
# File 'lib/plurimath/utility.rb', line 1016

def base_is_prime?(base)
  symbol_prime?(base.parameter_two) ||
    primes_constants.key(base.parameter_two.value)
end

.base_is_sub_or_sup?(base) ⇒ Boolean

Returns:

  • (Boolean)


1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'lib/plurimath/utility.rb', line 1039

def base_is_sub_or_sup?(base)
  case base
  when Math::Formula
    base_is_sub_or_sup?(base.value.first)
  when Math::Function::Fenced
    base_is_sub_or_sup?(base.parameter_two.first)
  when Math::Symbols::Symbol, Math::Number
    base.mini_sub_sized || base_mini_sup_sized
  end
end

.base_recursion(sub_script, sub_recursion) ⇒ Object



976
977
978
979
980
981
982
983
984
985
# File 'lib/plurimath/utility.rb', line 976

def base_recursion(sub_script, sub_recursion)
  base_class = Math::Function::Base
  new_sub = sub_recursion.parameter_one
  if new_sub.is_a?(base_class)
    base_recursion(sub_script, new_sub)
  else
    sub_recursion.parameter_one = base_class.new(sub_script, new_sub)
  end
  sub_recursion
end

.binary_function_classes(mrow, lang:, under: false) ⇒ Object



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
# File 'lib/plurimath/utility.rb', line 696

def binary_function_classes(mrow, lang:, under: false)
  binary_class = Math::Function::BinaryFunction
  mrow.each_with_index do |object, ind|
    if object.is_a?(String)
      mrow[ind] =
        mathml_unary_classes([object], lang: lang)
    end
    object = mrow[ind]
    next unless object.is_a?(binary_class)

    if object.is_a?(Math::Function::Mod)
      next unless mrow.length >= 1

      object.parameter_one = mrow.delete_at(ind - 1) unless ind.zero?
      object.parameter_two = mrow.delete_at(ind)
    elsif Mathml::Constants::UNICODE_SYMBOLS.invert[object.class_name] && mrow.length > 1
      next if object.parameter_one || mrow.length > 2
      next object.parameter_one = mrow.delete_at(ind - 1) if under && ind <= 1

      object.parameter_one = mrow.delete_at(ind + 1)
    end
  end
end

.capitalize(text) ⇒ Object



262
263
264
# File 'lib/plurimath/utility.rb', line 262

def capitalize(text)
  text.to_s.split("_").map(&:capitalize).join
end

.enclosure_attrs(mask) ⇒ Object



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
# File 'lib/plurimath/utility.rb', line 1061

def enclosure_attrs(mask)
  raise "enclosure mask is not between 0 and 255" if mask.nil? || mask.negative? || mask > 255

  ret = ""
  unless mask.nil?
    mask ^= 15
    bin_mask = mask.to_s(2).reverse
    classes = bin_mask.chars.each_with_index.filter_map do |bit, i|
      MASK_CLASSES[2**i] if bit == "1"
    end
    ret = classes.join(" ")
  end
  ret
end

.fenceable_classes(mrow = []) ⇒ Object



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
# File 'lib/plurimath/utility.rb', line 761

def fenceable_classes(mrow = [])
  return false unless mrow.length > 1
  return unless paren_able?(PARENTHESIS,
                            mrow) || (mrow.first.is_a?(Math::Symbols::Paren) && mrow.last.is_a?(Math::Symbols::Paren))

  open_paren = mrow.shift
  close_paren = mrow.pop
  if mrow.length == 1 && mrow.first.is_a?(Math::Function::Table)
    table = mrow.first
    table.open_paren = open_paren
    table.close_paren = close_paren
  else
    mrow.replace(
      [
        Math::Function::Fenced.new(open_paren, mrow.dup, close_paren),
      ],
    )
  end
end

.filter_math_zone_values(value, lang:, intent: false, options: nil) ⇒ Object



794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
# File 'lib/plurimath/utility.rb', line 794

def filter_math_zone_values(value, lang:, intent: false, options: nil)
  return [] if value&.empty?

  new_arr = []
  temp_array = []
  skip_index = nil
  value.each_with_index do |obj, index|
    object = obj.dup
    next if index == skip_index
    if TEXT_CLASSES.include?(object.class_name) || math_display_text_objects(object)
      next temp_array << (if object.is_a?(Math::Symbols::Symbol)
                            symbol_to_text(
                              object, lang: lang, intent: intent, options: options
                            )
                          else
                            object.value
                          end)
    end

    if temp_array.any?
      new_arr << Math::Function::Text.new(temp_array.join(" "),
                                          lang: lang)
    end
    temp_array = []
    new_arr << object
  end
  if temp_array.any?
    new_arr << Math::Function::Text.new(temp_array.join(" "),
                                        lang: lang)
  end
  new_arr
end

.filter_table_data(table_data) ⇒ Object



227
228
229
230
231
232
233
234
235
236
# File 'lib/plurimath/utility.rb', line 227

def filter_table_data(table_data)
  table_data.each_with_index do |object, ind|
    if object.is_a?(Math::Symbols::Minus)
      table_data[ind] = Math::Formula.new(
        [object, table_data.delete_at(ind.next)],
      )
    end
  end
  table_data
end

.filter_values(array, new_formula: true) ⇒ Object



348
349
350
351
352
353
354
355
356
# File 'lib/plurimath/utility.rb', line 348

def filter_values(array, new_formula: true)
  return array unless array.is_a?(Array) || array.is_a?(Math::Formula)

  array = array.is_a?(Math::Formula) ? array.value : array.flatten.compact
  return Math::Formula.new(array) if array.length > 1 && new_formula
  return array if array.length > 1 && !new_formula

  array.first
end

.find_pos_chr(fonts_array, key) ⇒ Object



393
394
395
# File 'lib/plurimath/utility.rb', line 393

def find_pos_chr(fonts_array, key)
  fonts_array.find { |d| d.is_a?(Hash) && d[key] }
end

.frac_values(object) ⇒ Object



618
619
620
621
622
623
624
625
# File 'lib/plurimath/utility.rb', line 618

def frac_values(object)
  case object
  when Math::Formula
    object.value.any? { |d| symbol_value(d, ",") }
  when Array
    object.any? { |d| symbol_value(d, ",") }
  end
end

.fractions(numerator, denominator, options = nil) ⇒ Object



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
# File 'lib/plurimath/utility.rb', line 921

def fractions(numerator, denominator, options = nil)
  frac_class = Math::Function::Frac
  if denominator.is_a?(frac_class)
    if denominator.parameter_one.is_a?(frac_class)
      recursion_fraction(denominator, numerator, options)
    else
      denominator.parameter_one = frac_class.new(
        unfenced_value(numerator, paren_specific: true),
        unfenced_value(denominator.parameter_one, paren_specific: true),
        options,
      )
    end
    denominator
  else
    frac_class.new(
      unfenced_value(numerator, paren_specific: true),
      unfenced_value(denominator, paren_specific: true),
      options,
    )
  end
end

.get_class(text) ⇒ Object



248
249
250
# File 'lib/plurimath/utility.rb', line 248

def get_class(text)
  Object.const_get("Plurimath::Math::Function::#{capitalize(text)}")
end

.get_paren_class(text) ⇒ Object



258
259
260
# File 'lib/plurimath/utility.rb', line 258

def get_paren_class(text)
  Object.const_get("Plurimath::Math::Symbols::Paren::#{capitalize(text)}")
end

.get_symbol_class(text) ⇒ Object



252
253
254
255
256
# File 'lib/plurimath/utility.rb', line 252

def get_symbol_class(text)
  Object.const_get("Plurimath::Math::Symbols::#{capitalize(text)}")
rescue StandardError
  get_paren_class(text)
end

.get_table_class(text) ⇒ Object



238
239
240
# File 'lib/plurimath/utility.rb', line 238

def get_table_class(text)
  Object.const_get("Plurimath::Math::Function::Table::#{capitalize(text)}")
end

.hexcode_in_input(field) ⇒ Object



1033
1034
1035
1036
1037
# File 'lib/plurimath/utility.rb', line 1033

def hexcode_in_input(field)
  field.input(:unicodemath)&.flatten&.find do |input|
    input.match?(/&#x.+;/)
  end
end

.html_entity_to_unicode(string) ⇒ Object



467
468
469
470
471
# File 'lib/plurimath/utility.rb', line 467

def html_entity_to_unicode(string)
  return string unless string&.include?("&")

  HTML_ENTITIES.decode(string)
end

.identity_matrix(size) ⇒ Object



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
# File 'lib/plurimath/utility.rb', line 1050

def identity_matrix(size)
  matrix = Array.new(size) { Array.new(size, 0) }
  size.times { |i| matrix[i][i] = 1 }
  matrix.map do |tr|
    tr.map.with_index do |td, i|
      tr[i] = Math::Function::Td.new([Math::Number.new(td.to_s)])
    end
    Math::Function::Tr.new(tr)
  end
end

.join_attr_value(attrs, value, unicode_only: false, lang: :mathml) ⇒ Object



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'lib/plurimath/utility.rb', line 493

def join_attr_value(attrs, value, unicode_only: false, lang: :mathml)
  if attrs.is_a?(Hash) && attrs.key?(:intent)
    [
      Math::Function::Intent.new(
        filter_values(join_attr_value(nil, value,
                                      unicode_only: unicode_only, lang: lang)),
        Math::Function::Text.new(attrs[:intent], lang: lang),
      ),
    ]
  elsif value.any?(String)
    new_value = mathml_unary_classes(value, unicode_only: unicode_only,
                                            lang: lang)
    array_value = Array(new_value)
    if attrs.nil?
      array_value
    else
      join_attr_value(attrs, array_value,
                      unicode_only: unicode_only)
    end
  elsif attrs.nil?
    value
  elsif attrs.is_a?(String) && ["solid",
                                "none"].include?(attrs.split.first.downcase)
    table_separator(attrs.split, value)
  elsif attrs.is_a?(Hash)
    if attrs.key?(:accent) || attrs.key?(:accentunder)
      attr_is_accent(attrs, value)
    elsif attrs.key?(:linebreak)
      Math::Function::Linebreak.new(value.first, attrs)
    elsif attrs.key?(:bevelled) || attrs.key?(:linethickness)
      Math::Function::Frac.new(value[0], value[1], attrs)
    elsif attrs.key?(:notation)
      value << attrs
    elsif attrs.key?(:separators)
      fenced = Math::Function::Fenced.new(
        symbol_object(attrs[:open] || "(", lang: lang),
        value,
        symbol_object(attrs[:close] || ")", lang: lang),
      )
      fenced.options = { separators: attrs[:separators] }
      fenced
    elsif TABLE_SUPPORTED_ATTRS.any? { |atr| attrs.key?(atr) }
      Math::Function::Table.new(value, nil, nil, attrs)
    elsif MPADDED_ATTRS.any? { |atr| attrs.key?(atr) }
      Math::Function::Mpadded.new(
        filter_values(value),
        attrs,
      )
    elsif MGLYPH_ATTRS.any? { |atr| attrs.key?(atr) }
      Math::Function::Mglyph.new(
        attrs,
      )
    end
  elsif attrs.is_a?(Math::Core)
    attr_is_function(attrs, value)
  end
end

.latex_table_curly_paren(string) ⇒ Object



1114
1115
1116
1117
1118
1119
1120
# File 'lib/plurimath/utility.rb', line 1114

def latex_table_curly_paren(string)
  case string
  when "{" then Math::Symbols::Paren::Lcurly.new
  when "}" then Math::Symbols::Paren::Rcurly.new
  else symbols_class(string, lang: :latex)
  end
end

.left_right_objects(paren, function) ⇒ Object



665
666
667
668
669
670
671
672
# File 'lib/plurimath/utility.rb', line 665

def left_right_objects(paren, function)
  paren = if paren.to_s.match?(/\\\{|\\\}/)
            paren.to_s.gsub("\\", "")
          else
            Latex::Constants::LEFT_RIGHT_PARENTHESIS[paren.to_sym]
          end
  get_class(function).new(paren)
end

.math_display_text_objects(object) ⇒ Object



1109
1110
1111
1112
# File 'lib/plurimath/utility.rb', line 1109

def math_display_text_objects(object)
  class_names = ["plus", "minus", "circ", "equal", "symbol"].freeze
  class_names.include?(object.class_name)
end

.mathml_unary_classes(text_array, omml: false, unicode_only: false, lang: nil) ⇒ Object



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/plurimath/utility.rb', line 425

def mathml_unary_classes(text_array, omml: false, unicode_only: false,
lang: nil)
  return [] if text_array.empty?

  compacted = text_array.compact
  return filter_values(compacted) unless compacted.any?(String)

  string  = compacted.join
  classes = Mathml::Constants::CLASSES
  unicode = string_to_html_entity(string)
  return symbols_class(unicode, lang: lang) if unicode_only && unicode

  symbol = Mathml::Constants::UNICODE_SYMBOLS[unicode.strip.to_sym]
  if classes.include?(symbol&.strip)
    get_class(symbol.strip).new
  elsif classes.any?(string&.strip)
    get_class(string.strip).new
  elsif omml
    text_classes(string,
                 lang: lang)
  else
    symbols_class(unicode, lang: lang)
  end
end

.mrow_left_right(mrow = []) ⇒ Object



680
681
682
683
684
685
686
# File 'lib/plurimath/utility.rb', line 680

def mrow_left_right(mrow = [])
  object = mrow.first
  !(
    (object.is_a?(Math::Function::TernaryFunction) && object.any_value_exist? && (mrow.length <= 2)) ||
    (object.is_a?(Math::Function::UnaryFunction) && mrow.length == 1)
  )
end

.nary_fonts(nary, lang:) ⇒ Object



380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/plurimath/utility.rb', line 380

def nary_fonts(nary, lang:)
  narypr  = nary.first.flatten.compact
  subsup  = narypr.any?("undOvr") ? "undOvr" : "subSup"
  unicode = narypr.any?(Hash) ? narypr.first[:chr] : ""
  Math::Function::Nary.new(
    symbols_class(string_to_html_entity(unicode), lang: lang),
    filter_values(nary[1]),
    filter_values(nary[2]),
    filter_values(nary[3]),
    { type: subsup },
  )
end

.nil_to_none_object(value) ⇒ Object



580
581
582
583
584
585
586
587
588
589
590
# File 'lib/plurimath/utility.rb', line 580

def nil_to_none_object(value)
  return value unless value.any?(NilClass) || value.any? do |val|
    val.is_a?(Array) && val.empty?
  end

  value.each.with_index do |val, index|
    next unless val.nil? || val.is_a?(Array)

    value[index] = Math::Function::None.new
  end
end

.notations_to_mask(notations) ⇒ Object



1076
1077
1078
1079
1080
1081
# File 'lib/plurimath/utility.rb', line 1076

def notations_to_mask(notations)
  mask = notations.split.map do |notation|
    MASK_CLASSES.key(notation)
  end
  mask.inject(*:+) ^ 15
end

.organize_options(table_data, column_align) ⇒ Object



195
196
197
198
199
200
201
# File 'lib/plurimath/utility.rb', line 195

def organize_options(table_data, column_align)
  return column_align if column_align.length <= 1

  align = [column_align&.shift]
  table_data.insert(0, *column_align)
  align
end

.organize_table(array, column_align: nil, options: nil) ⇒ Object



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/plurimath/utility.rb', line 164

def organize_table(array, column_align: nil, options: nil)
  table = []
  table_data = []
  table_row = []
  organize_options(array, column_align) if options
  string_columns = column_align&.map { |column| column.is_a?(Math::Symbols::Paren) ? "|" : column.value }
  array.each do |data|
    if data&.separate_table
      table_row << Math::Function::Td.new(filter_table_data(table_data).compact)
      table_data = []
      if data.linebreak?
        organize_tds(table_row.flatten, string_columns.dup, options)
        table << Math::Function::Tr.new(table_row)
        table_row = []
      end
      next
    end
    table_data << data
  end
  table_row << Math::Function::Td.new(table_data.compact) if table_data
  unless table_row.nil? || table_row.empty?
    organize_tds(table_row.flatten, string_columns.dup, options)
    table << Math::Function::Tr.new(table_row)
  end
  unless column_align.nil? || column_align.empty?
    table_separator(string_columns, table,
                    symbol: "|")
  end
  table
end

.organize_tds(tr_array, column_align, options) ⇒ Object



216
217
218
219
220
221
222
223
224
225
# File 'lib/plurimath/utility.rb', line 216

def organize_tds(tr_array, column_align, options)
  return tr_array if column_align.nil? || column_align.empty?

  column_align.reject! { |string| string == "|" }
  column_align = column_align * tr_array.length if options
  tr_array.map.with_index do |td, ind|
    columnalign = ALIGNMENT_LETTERS[column_align[ind]&.to_sym]
    td.parameter_two = { columnalign: columnalign } if columnalign
  end
end

.ox_element(node, attributes: [], namespace: "") ⇒ Object



311
312
313
314
315
316
317
# File 'lib/plurimath/utility.rb', line 311

def ox_element(node, attributes: [], namespace: "")
  namespace = "#{namespace}:" unless namespace.empty?

  element = Plurimath.xml_engine.new_element("#{namespace}#{node}")
  element.set_attr(attributes)
  element
end

.paren_able?(arr = [], mrow = []) ⇒ Boolean

Returns:

  • (Boolean)


754
755
756
757
758
759
# File 'lib/plurimath/utility.rb', line 754

def paren_able?(arr = [], mrow = [])
  arr.any? do |opening, closing|
    symbol_value(mrow.first,
                 opening.to_s) && symbol_value(mrow.last, closing.to_s)
  end
end

.paren_filesObject



266
267
268
# File 'lib/plurimath/utility.rb', line 266

def paren_files
  Math::Symbols::Paren.descendants
end

.parens_hash(lang, skipables: nil) ⇒ Object



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/plurimath/utility.rb', line 290

def parens_hash(lang, skipables: nil)
  @@parens ||= {}
  lang_parens = @@parens[lang]
  return lang_parens if lang_parens && !lang_parens.empty?

  lang_parens = {}
  paren_files.map do |class_object|
    class_object::INPUT[lang]&.flatten&.each do |symbol|
      next if skipables&.include?(class_object.new.class_name)
      next if lang_parens.key?(symbol)

      lang_parens[symbol] = class_object
    end
  end
  @@parens[lang] = lang_parens.sort_by { |v, _| -v.length }.to_h
end

.populate_function_classes(mrow = [], lang:) ⇒ Object



688
689
690
691
692
693
694
# File 'lib/plurimath/utility.rb', line 688

def populate_function_classes(mrow = [], lang:)
  flatten_mrow = mrow.flatten.compact
  unary_function_classes(flatten_mrow, lang: lang)
  binary_function_classes(flatten_mrow, lang: lang)
  ternary_function_classes(flatten_mrow)
  flatten_mrow
end

.pr_element(main_tag, wi_tag = false, namespace: "") ⇒ Object



340
341
342
343
344
345
346
# File 'lib/plurimath/utility.rb', line 340

def pr_element(main_tag, wi_tag = false, namespace: "")
  tag_name = "#{main_tag}Pr"
  ox_element(
    tag_name,
    namespace: namespace,
  ) << rpr_element(wi_tag: wi_tag)
end

.primes_constantsObject



1026
1027
1028
1029
1030
1031
# File 'lib/plurimath/utility.rb', line 1026

def primes_constants
  primes = {}
  primes
    .merge!(UnicodeMath::Constants::PREFIXED_PRIMES)
    .merge({ sprime: "&#x27;" })
end

.recursion_fraction(frac, numerator, options) ⇒ Object



943
944
945
946
947
948
949
950
951
952
953
954
955
956
# File 'lib/plurimath/utility.rb', line 943

def recursion_fraction(frac, numerator, options)
  frac_class = Math::Function::Frac
  new_numerator = frac.parameter_one
  if new_numerator.is_a?(frac_class)
    recursion_fraction(new_numerator, numerator, options)
  else
    frac.parameter_one = frac_class.new(
      unfenced_value(numerator, paren_specific: true),
      unfenced_value(frac.parameter_one, paren_specific: true),
      options,
    )
    frac
  end
end

.recursive_sub(sub_script, sub_recursion) ⇒ Object



958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
# File 'lib/plurimath/utility.rb', line 958

def recursive_sub(sub_script, sub_recursion)
  base_class = Math::Function::Base
  if sub_recursion.is_a?(base_class)
    if sub_recursion.parameter_one.is_a?(base_class)
      base_recursion(sub_script, sub_recursion)
    else
      sub_recursion.parameter_one = base_class.new(sub_script,
                                                   sub_recursion.parameter_one)
    end
    sub_recursion
  else
    base_class.new(
      sub_script,
      sub_recursion,
    )
  end
end

.recursive_sup(sup_script, sup_recursion) ⇒ Object



987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
# File 'lib/plurimath/utility.rb', line 987

def recursive_sup(sup_script, sup_recursion)
  power_class = Math::Function::Power
  if sup_recursion.is_a?(power_class)
    if sup_recursion.parameter_one.is_a?(power_class)
      sup_recursion(sup_script, sup_recursion)
    else
      sup_recursion.parameter_one = power_class.new(sup_script,
                                                    sup_recursion.parameter_one)
    end
    sup_recursion
  else
    power_class.new(
      sup_script,
      sup_recursion,
    )
  end
end

.rpr_element(wi_tag: false) ⇒ Object



319
320
321
322
323
324
325
326
327
328
329
# File 'lib/plurimath/utility.rb', line 319

def rpr_element(wi_tag: false)
  rpr_element = ox_element("rPr", namespace: "w")
  attributes = { "w:ascii": "Cambria Math", "w:hAnsi": "Cambria Math" }
  rpr_element << ox_element(
    "rFonts",
    namespace: "w",
    attributes: attributes,
  )
  rpr_element << ox_element("i", namespace: "w") if wi_tag
  rpr_element
end

.sequence_slashed_values(values, lang:) ⇒ Object



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
# File 'lib/plurimath/utility.rb', line 1092

def sequence_slashed_values(values, lang:)
  values.each.with_index do |value, index|
    decoded = HTMLEntities.new.decode(value.value)
    slashed = if index.zero?
                slashed_values(value.value)
              elsif decoded.match?(/[0-9]/)
                Math::Number.new(decoded)
              else
                symbols_class(
                  decoded, lang: lang
                )
              end
    values[index] = slashed
  end
  values
end

.slashed_values(value) ⇒ Object



1083
1084
1085
1086
1087
1088
1089
1090
# File 'lib/plurimath/utility.rb', line 1083

def slashed_values(value)
  decoded = HTMLEntities.new.decode(value)
  if decoded.to_s.match?(/^\w+/)
    Math::Function::Text.new("\\#{decoded}")
  else
    Math::Symbols::Symbol.new(decoded, true)
  end
end

.string_to_html_entity(string) ⇒ Object



458
459
460
461
462
463
# File 'lib/plurimath/utility.rb', line 458

def string_to_html_entity(string)
  HTML_ENTITIES.encode(
    string.frozen? ? string : string.force_encoding("UTF-8"),
    :hexadecimal,
  )
end

.sub_sup_method?(sub_sup) ⇒ Boolean

Returns:

  • (Boolean)


242
243
244
245
246
# File 'lib/plurimath/utility.rb', line 242

def sub_sup_method?(sub_sup)
  if sub_sup.methods.include?(:class_name)
    Html::Constants::SUB_SUP_CLASSES.value?(sub_sup.class_name.to_sym)
  end
end

.sup_recursion(sup_script, sup_recursion) ⇒ Object



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# File 'lib/plurimath/utility.rb', line 1005

def sup_recursion(sup_script, sup_recursion)
  power_class = Math::Function::Power
  new_sup = sup_recursion.parameter_one
  if new_sup.is_a?(power_class)
    sup_recursion(sup_script, new_sup)
  else
    sup_recursion.parameter_one = power_class.new(sup_script, new_sup)
  end
  sup_recursion
end

.symbol_object(value, lang: nil) ⇒ Object



637
638
639
640
641
642
643
644
645
646
# File 'lib/plurimath/utility.rb', line 637

def symbol_object(value, lang: nil)
  value = case value
          when "" then "{:"
          when "" then ":}"
          when "" then "&#x2329;"
          when "" then "&#x232a;"
          else value
          end
  symbols_class(value, lang: lang)
end

.symbol_prime?(obj) ⇒ Boolean

Returns:

  • (Boolean)


1021
1022
1023
1024
# File 'lib/plurimath/utility.rb', line 1021

def symbol_prime?(obj)
  obj&.class&.const_defined?(:INPUT) &&
    primes_constants&.key(hexcode_in_input(obj))
end

.symbol_to_text(symbol, lang:, options:, intent: false) ⇒ Object



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
# File 'lib/plurimath/utility.rb', line 827

def symbol_to_text(symbol, lang:, options:, intent: false)
  case lang
  when :asciimath
    symbol.to_asciimath(options: options)
  when :latex
    symbol.to_latex(options: options)
  when :mathml
    symbol.to_mathml_without_math_tag(intent,
                                      options: options).nodes.first
  when :omml
    symbol.to_omml_without_math_tag(true, options: options)
  when :unicodemath
    symbol.to_unicodemath(options: options)
  end
end

.symbol_value(object, value) ⇒ Object



408
409
410
411
412
413
414
# File 'lib/plurimath/utility.rb', line 408

def symbol_value(object, value)
  (object.is_a?(Math::Symbols::Comma) if value&.include?(",")) ||
    (object.is_a?(Math::Symbols::Minus) if value&.include?("-")) ||
    (object.is_a?(Math::Symbols::Paren::Vert) if value&.include?("|")) ||
    (object.is_a?(Math::Symbols::Symbol) && object&.value&.include?(value)) ||
    (value == "\\\\" && object.is_a?(Math::Function::Linebreak))
end

.symbols_class(string, lang:, table: false) ⇒ Object



450
451
452
453
454
455
456
# File 'lib/plurimath/utility.rb', line 450

def symbols_class(string, lang:, table: false)
  return string unless string.is_a?(String) || string.is_a?(Parslet::Slice)
  return latex_table_curly_paren(string) if table && lang == :latex

  all_symbols_classes(lang)[string.to_s.strip]&.new ||
    Math::Symbols::Symbol.new(string)
end

.symbols_filesObject



270
271
272
# File 'lib/plurimath/utility.rb', line 270

def symbols_files
  Math::Symbols::Symbol.descendants
end

.symbols_hash(lang) ⇒ Object



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/plurimath/utility.rb', line 274

def symbols_hash(lang)
  @@symbols ||= {}
  lang_symbols = @@symbols[lang]
  return lang_symbols if lang_symbols && !lang_symbols.empty?

  lang_symbols = {}
  symbols_files.map do |class_object|
    class_object::INPUT[lang]&.flatten&.each do |symbol|
      next if lang_symbols.key?(symbol)

      lang_symbols[symbol] = class_object
    end
  end
  @@symbols[lang] = lang_symbols.sort_by { |v, _| -v.length }.to_h
end

.table_options(table_data) ⇒ Object



203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/plurimath/utility.rb', line 203

def table_options(table_data)
  rowline = ""
  table_data.map do |tr|
    if tr&.parameter_one&.first&.parameter_one&.first.is_a?(Math::Symbols::Hline)
      rowline += "solid "
    else
      rowline += "none "
    end
  end
  options = { rowline: rowline.strip } if rowline.include?("solid")
  options || {}
end

.table_separator(separator, value, symbol: "solid") ⇒ Object



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/plurimath/utility.rb', line 473

def table_separator(separator, value, symbol: "solid")
  sep_symbol = Math::Function::Td.new([Math::Symbols::Paren::Vert.new])
  separator&.each_with_index do |sep, ind|
    next unless sep == symbol

    value.map do |val|
      val.parameter_one.insert(ind + 1, sep_symbol) if symbol == "solid"
      val.parameter_one.insert(ind, sep_symbol) if symbol == "|"
      begin
        (val.parameter_one[val.parameter_one.index(nil)] =
           Math::Function::Td.new([]))
      rescue StandardError
        nil
      end
      val
    end
  end
  value
end

.table_td(object) ⇒ Object



627
628
629
630
631
632
633
634
635
# File 'lib/plurimath/utility.rb', line 627

def table_td(object)
  new_object = case object
               when Math::Function::Td
                 object
               else
                 Math::Function::Td.new([object])
               end
  Array(new_object)
end

.td_value(td_object) ⇒ Object



416
417
418
419
420
421
422
423
# File 'lib/plurimath/utility.rb', line 416

def td_value(td_object)
  str_classes = [String, Parslet::Slice]
  if str_classes.include?(td_object.class) && td_object.to_s.empty?
    return Math::Function::Text.new(nil)
  end

  td_object
end

.td_values(objects, slicer) ⇒ Object



397
398
399
400
401
402
403
404
405
406
# File 'lib/plurimath/utility.rb', line 397

def td_values(objects, slicer)
  sliced = objects.slice_when { |object, _| symbol_value(object, slicer) }
  tds = sliced.map do |slice|
    Math::Function::Td.new(
      slice.delete_if { |d| symbol_value(d, slicer) }.compact,
    )
  end
  tds << Math::Function::Td.new([]) if symbol_value(objects.last, slicer)
  tds
end

.ternary_function_classes(mrow) ⇒ Object



739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'lib/plurimath/utility.rb', line 739

def ternary_function_classes(mrow)
  ternary_class = Math::Function::TernaryFunction
  if mrow.any?(ternary_class) && mrow.length > 1
    mrow.each_with_index do |object, ind|
      if object.is_a?(ternary_class)
        next if [Math::Function::Fenced, Math::Function::Multiscript].include?(object.class)
        next unless object.parameter_one || object.parameter_two
        next if object.parameter_three

        object.parameter_three = filter_values(mrow.delete_at(ind + 1))
      end
    end
  end
end

.text_classes(text, lang:) ⇒ Object



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/plurimath/utility.rb', line 358

def text_classes(text, lang:)
  return nil unless text

  text = filter_values(text) unless text.is_a?(String)
  return text if text.is_a?(Math::Core)

  if text&.scan(/[[:digit:]]/)&.length == text&.length
    Math::Number.new(text)
  elsif text&.match?(/[a-zA-Z]/)
    Math::Function::Text.new(text, lang: lang)
  else
    text = string_to_html_entity(text)
      .gsub("&#x26;", "&")
      .gsub("&#x3c;", "<")
      .gsub("&#x27;", "'")
      .gsub("&#xa0;", " ")
      .gsub("&#x3e;", ">")
      .gsub("&#xa;", "\n")
    symbols_class(text, lang: lang)
  end
end

.transform_accents(accents, lang:) ⇒ Object



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
# File 'lib/plurimath/utility.rb', line 858

def transform_accents(accents, lang:)
  accents.reduce do |function, accent|
    if function.is_a?(Hash)
      if function[:prime_accent_symbols]
        Math::Function::Power.new(
          unfenced_value(
            accent_value(function, function: true,
                                   lang: lang), paren_specific: true
          ),
          accent_value(accent, lang: lang),
        )
      else
        Math::Function::Overset.new(
          accent_value(accent, lang: lang),
          unfenced_value(
            accent_value(function, function: true,
                                   lang: lang), paren_specific: true
          ),
          { accent: true },
        )
      end
    elsif accent[:prime_accent_symbols]
      Math::Function::Power.new(
        unfenced_value(function, paren_specific: true),
        accent_value(accent, lang: lang),
      )
    else
      Math::Function::Overset.new(
        accent_value(accent, lang: lang),
        unfenced_value(function, paren_specific: true),
        { accent: true },
      )
    end
  end
end

.unary_function_classes(mrow, lang:) ⇒ Object



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
# File 'lib/plurimath/utility.rb', line 720

def unary_function_classes(mrow, lang:)
  unary_class = Math::Function::UnaryFunction
  if mrow.any?(String) || mrow.any?(unary_class)
    mrow.each_with_index do |object, ind|
      if object.is_a?(String)
        mrow[ind] =
          mathml_unary_classes([object], lang: lang)
      end
      object = mrow[ind] if object.is_a?(String)
      next unless object.is_a?(unary_class)
      next if object.is_a?(Math::Function::Text)
      next if object.parameter_one || mrow[ind + 1].nil?
      next unless ind.zero?

      object.parameter_one = mrow.delete_at(ind + 1)
    end
  end
end

.unfenced_value(object, paren_specific: false) ⇒ Object



592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'lib/plurimath/utility.rb', line 592

def unfenced_value(object, paren_specific: false)
  case object
  when Math::Function::Fenced
    if !paren_specific || (paren_specific && valid_paren?(object))
      filter_values(object.parameter_two)
    else
      object
    end
  when Array
    filter_values(object)
  else
    object
  end
end

.unicode_accents(accents, lang: :unicodemath) ⇒ Object



843
844
845
846
847
848
849
850
851
852
853
854
855
856
# File 'lib/plurimath/utility.rb', line 843

def unicode_accents(accents, lang: :unicodemath)
  if accents.is_a?(Math::Function::BinaryFunction)
    accents
  elsif accents.any? { |acc| acc&.dig(:first_value)&.is_a?(Array) }
    accent_value = accents.first[:first_value].pop
    first_value = accents.first[:first_value]
    accents.first[:first_value] = accent_value
    Math::Formula.new(
      first_value + [transform_accents(accents, lang: lang)],
    )
  else
    transform_accents(accents, lang: lang)
  end
end

.unicode_fractions(fractions) ⇒ Object



904
905
906
907
908
909
910
911
# File 'lib/plurimath/utility.rb', line 904

def unicode_fractions(fractions)
  frac_arr = UnicodeMath::Constants::UNICODE_FRACTIONS[fractions.to_sym]
  Math::Function::Frac.new(
    Math::Number.new(frac_arr.first.to_s),
    Math::Number.new(frac_arr.last.to_s),
    { displaystyle: false, unicodemath_fraction: true },
  )
end

.update_nodes(element, nodes) ⇒ Object



331
332
333
334
335
336
337
338
# File 'lib/plurimath/utility.rb', line 331

def update_nodes(element, nodes)
  nodes&.each do |node|
    next update_nodes(element, node) if node.is_a?(Array)

    element << node unless node.nil?
  end
  element
end

.updated_primes(prime) ⇒ Object



913
914
915
916
917
918
919
# File 'lib/plurimath/utility.rb', line 913

def updated_primes(prime)
  filter_values(
    prime.to_s.scan(UNICODE_REGEX).map do |str|
      symbols_class(str, lang: :unicodemath)
    end,
  )
end

.valid_class(object) ⇒ Object



674
675
676
677
678
# File 'lib/plurimath/utility.rb', line 674

def valid_class(object)
  text = object.extract_class_name_from_text
  (object.extractable? && Asciimath::Constants::SUB_SUP_CLASSES.include?(text)) ||
    Latex::Constants::SYMBOLS[text.to_sym] == :power_base
end

.valid_paren?(object) ⇒ Boolean

Returns:

  • (Boolean)


607
608
609
610
611
612
613
614
615
616
# File 'lib/plurimath/utility.rb', line 607

def valid_paren?(object)
  object.parameter_one.is_a?(Math::Symbols::Paren::Lround) &&
    object.parameter_three.is_a?(Math::Symbols::Paren::Rround) &&
    object.options.keys.none? do |k|
      %i[open_paren close_paren].any?(k.to_sym)
    end &&
    !object.parameter_one.mini_sup_sized &&
    !object.parameter_three.mini_sub_sized &&
    object.options.empty?
end

.validate_left_right(fields = []) ⇒ Object



657
658
659
660
661
662
663
# File 'lib/plurimath/utility.rb', line 657

def validate_left_right(fields = [])
  fields.each do |field|
    if field.is_a?(Math::Formula) && field.value.first.is_a?(Math::Function::Left)
      field.left_right_wrapper = true
    end
  end
end

.validate_math_zone(object, lang:, intent: false, options: nil) ⇒ Object



781
782
783
784
785
786
787
788
789
790
791
792
# File 'lib/plurimath/utility.rb', line 781

def validate_math_zone(object, lang:, intent: false, options: nil)
  return false unless object

  if object.is_a?(Math::Formula)
    filter_math_zone_values(object.value, lang: lang, intent: intent,
                                          options: options).find do |value|
      !(value.is_a?(Math::Function::Text) || value.is_a?(Math::Symbols::Symbol))
    end
  else
    !(TEXT_CLASSES.include?(object.class_name) || object.is_a?(Math::Symbols::Symbol))
  end
end