Puppet Function: intersection

Defined in:
modules/stdlib/lib/puppet/parser/functions/intersection.rb
Function type:
Ruby 3.x API

Overview

intersection()Any

This function returns an array of the intersection of two.

Examples:

intersection(["a","b","c"],["b","c","d"])  # returns ["b","c"]
intersection(["a","b","c"],[1,2,3,4])      # returns [] (true, when evaluated as a Boolean)

Returns:

  • (Any)


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'modules/stdlib/lib/puppet/parser/functions/intersection.rb', line 5

newfunction(:intersection, :type => :rvalue, :doc => <<-DOC
  This function returns an array of the intersection of two.

  *Examples:*

      intersection(["a","b","c"],["b","c","d"])  # returns ["b","c"]
      intersection(["a","b","c"],[1,2,3,4])      # returns [] (true, when evaluated as a Boolean)
  DOC
           ) do |arguments|

  # Two arguments are required
  raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2

  first = arguments[0]
  second = arguments[1]

  unless first.is_a?(Array) && second.is_a?(Array)
    raise(Puppet::ParseError, 'intersection(): Requires 2 arrays')
  end

  result = first & second

  return result
end