Class: Prism::ImaginaryNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
lib/prism/node_ext.rb,
ext/prism/api_node.c

Overview

Represents an imaginary number literal.

1.0i
^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(numeric, location) ⇒ ImaginaryNode

def initialize: (numeric: Node, location: Location) -> void



7868
7869
7870
7871
 
# File 'lib/prism/node.rb', line 7868

def initialize(numeric, location)
  @numeric = numeric
  @location = location
end

Instance Attribute Details

#numeric ⇒ Object (readonly)

attr_reader numeric: Node



7865
7866
7867
 
# File 'lib/prism/node.rb', line 7865

def numeric
  @numeric
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



7941
7942
7943
 
# File 'lib/prism/node.rb', line 7941

def self.type
  :imaginary_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7874
7875
7876
 
# File 'lib/prism/node.rb', line 7874

def accept(visitor)
  visitor.visit_imaginary_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



7879
7880
7881
 
# File 'lib/prism/node.rb', line 7879

def child_nodes
  [numeric]
end

#comment_targets ⇒ Object

def comment_targets: () -> Array[Node | Location]



7889
7890
7891
 
# File 'lib/prism/node.rb', line 7889

def comment_targets
  [numeric]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7884
7885
7886
 
# File 'lib/prism/node.rb', line 7884

def compact_child_nodes
  [numeric]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ImaginaryNode



7894
7895
7896
7897
7898
7899
 
# File 'lib/prism/node.rb', line 7894

def copy(**params)
  ImaginaryNode.new(
    params.fetch(:numeric) { numeric },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



7905
7906
7907
 
# File 'lib/prism/node.rb', line 7905

def deconstruct_keys(keys)
  { numeric: numeric, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



7910
7911
7912
7913
7914
7915
 
# File 'lib/prism/node.rb', line 7910

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── numeric:\n"
  inspector << inspector.child_node(numeric, "    ")
  inspector.to_str
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



7931
7932
7933
 
# File 'lib/prism/node.rb', line 7931

def type
  :imaginary_node
end

#value ⇒ Object

Returns the value of the node as a Ruby Complex.



69
70
71
 
# File 'lib/prism/node_ext.rb', line 69

def value
  Complex(0, numeric.value)
end