# Function object

> Mediated Wiki article. Canonical URL: https://mediated.wiki/source/Function_object
> Markdown URL: https://mediated.wiki/source/Function_object.md
> Source: https://en.wikipedia.org/wiki/Function_object
> Source revision: 1346243026
> License: Creative Commons Attribution-ShareAlike 4.0 International (https://creativecommons.org/licenses/by-sa/4.0/)

{{Short description|Programming construct}}
{{About|the computer programming concept of function objects|functors in mathematics|Functor|the related concept in functional programming|Functor (functional programming)}}
{{More citations needed|date=February 2009}}
In [computer programming](/source/computer_programming), a '''function object'''{{efn|1=In C++, a '''functionoid''' is an object that has one major method, and a '''functor''' is a special case of a functionoid.<ref>[https://isocpp.org/wiki/faq/pointers-to-members#functor-vs-functionoid What's the difference between a functionoid and a functor?]</ref> They are similar to a function object, ''but not the same''.}} is a construct allowing an [object](/source/object_(computer_science)) to be invoked or called as if it were an ordinary [function](/source/subroutine), usually with the same syntax (a function parameter that can also be a function). In some languages, particularly C++, function objects are often called '''functors''' (not related to [the functional programming concept](/source/Functor_(functional_programming))).

== Description ==
A typical use of a function object is in writing [callback](/source/Callback_(computer_programming)) functions. A callback in [procedural languages](/source/procedural_programming), such as [C](/source/C_(programming_language)), may be performed by using [function pointer](/source/function_pointer)s.<ref>{{cite web
 | url        = http://progtutorials.tripod.com/cpp1.htm#_Toc50820124
 | title      = C++ Tutorial Part I - Basic: 5.10 Function pointers are mainly used to achieve call back technique, which will be discussed right after.
 | author     = Silan Liu
 | publisher  = TRIPOD: Programming Tutorials Copyright © Silan Liu 2002
 | quote      = Function pointers are mainly used to achieve call back technique, which will be discussed right after.
 | access-date = 2012-09-07
}}</ref> However it can be difficult or awkward to pass a state into or out of the callback function. This restriction also inhibits more dynamic behavior of the function. A function object solves those problems since the function is really a [façade](/source/facade_pattern) for a full object, carrying its own state.

Many modern (and some older) languages, e.g. [C++](/source/C%2B%2B), [Eiffel](/source/Eiffel_(programming_language)), [Groovy](/source/Groovy_(programming_language)), [Lisp](/source/Lisp_(programming_language)), [Smalltalk](/source/Smalltalk), [Perl](/source/Perl), [PHP](/source/PHP), [Python](/source/Python_(programming_language)), [Ruby](/source/Ruby_(programming_language)), [Scala](/source/Scala_(programming_language)), and many others, support [first-class function](/source/first-class_function) objects and may even make significant use of them.<ref>{{cite web
 | url        = http://progtutorials.tripod.com/cpp1.htm#_Toc50820124
 | title      = C++ Tutorial Part I - Basic: 5.10 Function pointers are mainly used to achieve call back technique, which will be discussed right after.
 | author     = Paweł Turlejski
 | date       = 2009-10-02
 | publisher  = Just a Few Lines
 | quote      = PHP 5.3, along with many other features, introduced closures. So now we can finally do all the cool stuff that Ruby / Groovy / Scala / any_modern_language guys can do, right? Well, we can, but we probably won’t… Here's why.
 | access-date = 2012-09-07
}}</ref> [Functional programming](/source/Functional_programming) languages additionally support [closures](/source/closure_(computer_science)), i.e. first-class functions that can 'close over' variables in their surrounding environment at creation time. During compilation, a transformation known as [lambda lifting](/source/lambda_lifting) converts the closures into function objects.

== In C and C++ ==
Consider the example of a sorting routine that uses a callback function to define an ordering relation between a pair of items. The following C/C++ program uses function pointers:
<!-- NOTE: For the compareInts() implementation below, see http://stackoverflow.com/a/10997428/1629102 for an explanation of why the more simple (int) a - (int) b would not work in all cases. -->
<syntaxhighlight lang="c">
#include <stdlib.h>

// qsort() callback function
// returns < 0 if a < b, > 0 if a > b, 0 if a == b
int compareInts(const void* a, const void* b) {
    return (*(int*)a - *(int*)b);
}

// ...

// prototype of qsort is
// void qsort(void* base, size_t nel, size_t width, int (*compar)(const void*, const void*));

// ...

int main(void) {
    int items[] = { 4, 3, 1, 2 };
    qsort(items, sizeof(items) / sizeof(items[0]), sizeof(items[0]), compareInts);
    return 0;
}
</syntaxhighlight>

In C++, a function object may be used instead of an ordinary function by defining a class that [overloads](/source/operator_overloading) the [function call operator](/source/function_call_operator) by defining an <code>operator()</code> member function. In C++, this may appear as follows:

<syntaxhighlight lang="cpp">
import std;

using std::vector;

// comparator predicate: returns true if a < b, false otherwise
class IntegerComparator {
public:
    bool operator()(const int& a, const int& b) const {
        return a < b;
    }
};

int main() {
    vector<int> items = { 4, 3, 1, 2 };
    std::ranges::sort(items, IntegerComparator());
    return 0;
}
</syntaxhighlight>

Notice that the syntax for providing the callback to the <code>std::sort()</code> function is identical, but an object is passed instead of a function pointer. When invoked, the callback function is executed just as any other member function, and therefore has full access to the other members (data or functions) of the object. Of course, this is just a trivial example. To understand what power a functor provides more than a regular function, consider the common use case of sorting objects by a particular field. In the following example, a functor is used to sort a simple employee database by each employee's ID number.

<syntaxhighlight lang="cpp">
import std;

using std::vector;

enum class SortField {
    NAME,
    AGE,
    ID
}

class CompareBy {
private:
    const SortField SORT_FIELD;
public:
    explicit CompareBy(SortField field):  
        SORT_FIELD{field} {}
    
    bool operator()(const Employee& a, const Employee& b) const {
        switch (SORT_FIELD) {
            case SortField::NAME:
                return a.getName() < b.getName();
            case SortField::AGE:
                return a.getAge() < b.getAge();
            case SortField::ID:
                return a.getId() < b.getId();
            default:
                std::unreachable();
        }
    }
};

int main() {
    vector<Employee> employees;
    
    // code to populate database
    
    // Sort the database by employee ID number
    std::range::sort(employees, CompareBy(SortField::ID));
    
    return 0;
}
</syntaxhighlight>

Using a lambda expression (introduced in [C++11](/source/C%2B%2B11)) provides a more succinct way to do the same thing.

<syntaxhighlight lang="cpp">
import std;

using std::vector;

int main() {
    vector<Employee> employees;

    // code to populate database

    const SortField field = SortField::ID;
    std::ranges::sort(employees, [&field](const Employee& a, const Employee& b) const -> bool { /* code to select and compare field */ });
    return 0;
}
</syntaxhighlight>

        
It is possible to use function objects in situations other than as callback functions. In this case, the shortened term ''functor'' is normally ''not'' used about the function object. Continuing the example,

<syntaxhighlight lang="cpp">
IntegerComparator cpm;
bool result = cpm(a, b);
</syntaxhighlight>

In addition to class type functors, other kinds of function objects are also possible in C++. They can take advantage of C++'s member-pointer or [template](/source/generic_programming) facilities. The expressiveness of templates allows some [functional programming](/source/functional_programming) techniques to be used, such as defining function objects in terms of other function objects (like [function composition](/source/function_composition_(computer_science))). Much of the C++ [Standard Template Library](/source/Standard_Template_Library) (STL) makes heavy use of template-based function objects.

Another way to create a function object in C++ is to define a non-explicit conversion function to a function pointer type, a function [reference](/source/reference_(C%2B%2B)) type, or a reference to function pointer type. Assuming the conversion does not discard [cv-qualifiers](/source/Type_qualifier), this allows an object of that type to be used as a function with the same [signature](/source/function_signature) as the type it is converted to. Modifying an earlier example to use this we obtain the following class, whose instances can be called like function pointers:<ref>{{cite web|url=https://en.cppreference.com/w/cpp/language/overload_resolution#Call_to_a_class_object|title=Overload resolution§Call to a class object|website=cppreference.com}}</ref>

<syntaxhighlight lang="cpp">
import std;

using std::vector;

// comparator predicate: returns true if a < b, false otherwise
class IntegerComparator {
public:
    static bool compare(const int& a, const int& b) noexcept {
        return a < b;
    }

    using CompareFn = decltype(compare);

    operator CompareFn*() const { 
        return compare; 
    }
};

int main() {
    vector<int> items = { 4, 3, 1, 2 };
    std::ranges::sort(items, IntegerComparator());
    return 0;
}
</syntaxhighlight>

=== Maintaining state ===
Another advantage of function objects is their ability to maintain a state that affects <code>operator()</code> between calls. For example, the following code defines a [generator](/source/generator_(computer_science)) counting from 10 upwards and is invoked 11 times.

<syntaxhighlight lang="cpp">
import std;

using std::cout;
using std::ostream_iterator;

class CountFrom {
private:
    int count;
public:
    CountFrom(int count): 
        count{count} {}
  
    int operator()() { 
        return count++; 
    }
};

int main() {
    const int state = 10;
    std::generate_n(
        ostream_iterator<int>(cout, "\n"), 11,
        CountFrom(state)
    );
}
</syntaxhighlight>

In [C++14](/source/C%2B%2B14) or later, the example above could be rewritten as:

<syntaxhighlight lang="cpp">
import std;

using std::cout;
using std::ostream_iterator;

int main() {
    std::generate_n(
        ostream_iterator<int>(cout, "\n"), 
        11,
        [count = 10]() mutable -> int { return count++; }
    );
}
</syntaxhighlight>

== In C# ==
In [C#](/source/C_Sharp_(programming_language)), function objects are declared via [delegate](/source/delegate_(CLI))s. A delegate can be declared using a named method or a [lambda expression](/source/Lambda_(programming)). Here is an example using a named method.

<syntaxhighlight lang="csharp">
using System;
using System.Collections.Generic;

static int CompareFunction(int x, int y)
{
    return x - y;
}

List<int> items = new(4, 3, 1, 2);
Comparison<int> del = CompareFunction;
items.Sort(del);
</syntaxhighlight>

Here is an example using a lambda expression.

<syntaxhighlight lang="csharp">
using System;
using System.Collections.Generic;

List<int> items = new(4, 3, 1, 2);
items.Sort((x, y) => x - y);
</syntaxhighlight>

== In D ==
[D](/source/D_(programming_language)) provides several ways to declare function objects: Lisp/Python-style via [closures](/source/closure_(computer_science)) or C#-style via [delegate](/source/delegate_(CLI))s, respectively:

<syntaxhighlight lang="d">
bool find(T)(T[] haystack, bool delegate(T) needle_test) {
    foreach (straw; haystack) {
        if (needle_test(straw)) {
            return true;
        }
    }
    return false;
}

void main() {
    int[] haystack = [345, 15, 457, 9, 56, 123, 456];
    int needle = 123;
    bool needleTest(int n) {
        return n == needle;
    }
    assert(find(haystack, &needleTest));
}
</syntaxhighlight>

The difference between a [delegate](/source/delegate_(CLI)) and a [closure](/source/closure_(computer_science)) in D is automatically and conservatively determined by the [compiler](/source/compiler). D also supports function literals, that allow a lambda-style definition:

<syntaxhighlight lang="d">
void main() {
    int[] haystack = [345, 15, 457, 9, 56, 123, 456];
    int needle = 123;
    assert(find(haystack, (int n) { return n == needle; }));
}
</syntaxhighlight>

To allow the compiler to inline the code (see above), function objects can also be specified C++-style via [operator overloading](/source/operator_overloading):

<syntaxhighlight lang="d">
bool find(T, F)(T[] haystack, F needle_test) {
    foreach (straw; haystack) {
        if (needle_test(straw)) {
            return true;
        }
    }
  return false;
}

void main() {
    int[] haystack = [345, 15, 457, 9, 56, 123, 456];
    int needle = 123;
    class NeedleTest {
        int needle;

        this(int n) { 
            needle = n; 
        }

        bool opCall(int n) {
            return n == needle;
        }
    }
    assert(find(haystack, new NeedleTest(needle)));
}
</syntaxhighlight>

== In Eiffel ==

In the [Eiffel](/source/Eiffel_(programming_language)) software development method and language, operations and objects are seen always as separate concepts. However, the [agent](/source/Eiffel_(programming_language)) mechanism facilitates the modeling of operations as runtime objects. Agents satisfy the range of application attributed to function objects, such as being passed as arguments in procedural calls or specified as callback routines. The design of the agent mechanism in Eiffel attempts to reflect the object-oriented nature of the method and language. An agent is an object that generally is a direct instance of one of the two library classes, which model the two types of routines in Eiffel: <code>PROCEDURE</code> and <code>FUNCTION</code>. These two classes descend from the more abstract <code>ROUTINE</code>.

Within software text, the language keyword <code>agent</code> allows agents to be constructed in a compact form. In the following example, the goal is to add the action of stepping the gauge forward to the list of actions to be executed in the event that a button is clicked.

<syntaxhighlight lang="eiffel">
my_button.select_actions.extend (agent my_gauge.step_forward)
</syntaxhighlight>

The routine <code>extend</code> referenced in the example above is a feature of a class in a [graphical user interface](/source/graphical_user_interface) (GUI) library to provide [event-driven programming](/source/event-driven_programming) capabilities.

In other library classes, agents are seen to be used for different purposes. In a library supporting data structures, for example, a class modeling linear structures effects [universal quantification](/source/universal_quantification) with a function <code>for_all</code> of type <code>BOOLEAN</code> that accepts an agent, an instance of <code>FUNCTION</code>, as an argument. So, in the following example, <code>my_action</code> is executed only if all members of <code>my_list</code> contain the character '!':

<syntaxhighlight lang="eiffel">
    my_list: LINKED_LIST [STRING]
        ...
            if my_list.for_all (agent {STRING}.has ('!')) then
                my_action
            end
        ...
</syntaxhighlight>

When agents are created, the arguments to the routines they model and even the target object to which they are applied can be either ''closed'' or left ''open''. Closed arguments and targets are given values at agent creation time. The assignment of values for open arguments and targets is deferred until some point after the agent is created. The routine <code>for_all</code> expects as an argument an agent representing a function with one open argument or target that conforms to actual generic parameter for the structure (<code>STRING</code> in this example.)

When the target of an agent is left open, the class name of the expected target, enclosed in braces, is substituted for an object reference as shown in the text <code>agent {STRING}.has ('!')</code> in the example above. When an argument is left open, the question mark character ('?') is coded as a placeholder for the open argument.

The ability to close or leave open targets and arguments is intended to improve the flexibility of the agent mechanism. Consider a class that contains the following procedure to print a string on standard output after a new line:

<syntaxhighlight lang="eiffel">
    print_on_new_line (s: STRING)
            -- Print `s' preceded by a new line
        do
            print ("%N" + s)
        end
</syntaxhighlight>

The following snippet, assumed to be in the same class, uses <code>print_on_new_line</code> to demonstrate the mixing of open arguments and open targets in agents used as arguments to the same routine.

<syntaxhighlight lang="eiffel">
    my_list: LINKED_LIST [STRING]
        ...
            my_list.do_all (agent print_on_new_line (?))
            my_list.do_all (agent {STRING}.to_lower)
            my_list.do_all (agent print_on_new_line (?))
        ...
</syntaxhighlight>

This example uses the procedure <code>do_all</code> for linear structures, which executes the routine modeled by an agent for each item in the structure.

The sequence of three instructions prints the strings in <code>my_list</code>, converts the strings to lowercase, and then prints them again.

Procedure <code>do_all</code> iterates across the structure executing the routine substituting the current item for either the open argument (in the case of the agents based on <code>print_on_new_line</code>), or the open target (in the case of the agent based on <code>to_lower</code>).

Open and closed arguments and targets also allow the use of routines that call for more arguments than are required by closing all but the necessary number of arguments:

<syntaxhighlight lang="eiffel">
my_list.do_all (agent my_multi_arg_procedure (closed_arg_1, ?, closed_arg_2, closed_arg_3)
</syntaxhighlight>

The Eiffel agent mechanism is detailed in the [http://www.ecma-international.org/publications/standards/Ecma-367.htm Eiffel ISO/ECMA standard document].

== In Java ==
[Java](/source/Java_(programming_language)) has no [first-class function](/source/first-class_function)s, so function objects are usually expressed by an interface with a single method (most commonly the <code>Callable</code> interface), typically with the implementation being an anonymous [inner class](/source/inner_class), or, starting in Java 8, a [lambda](/source/anonymous_function).

For an example from Java's standard library, <code>java.util.Collections.sort()</code> takes a <code>List</code> and a functor whose role is to compare objects in the List. Without first-class functions, the function is part of the Comparator interface. This could be used as follows.

<syntaxhighlight lang="java">
List<String> list = Arrays.asList("10", "1", "20", "11", "21", "12");

Comparator<String> numStringComparator = new Comparator<String>() {
    public int compare(String str1, String str2) {
        return Integer.valueOf(str1).compareTo(Integer.valueOf(str2));
    }
};

Collections.sort(list, numStringComparator);
</syntaxhighlight>

In Java 8+, this can be written as:
<syntaxhighlight lang="java">
List<String> list = Arrays.asList("10", "1", "20", "11", "21", "12");

Comparator<String> numStringComparator = (str1, str2) -> Integer.valueOf(str1).compareTo(Integer.valueOf(str2));

Collections.sort(list, numStringComparator);
</syntaxhighlight>

== In JavaScript ==
In [JavaScript](/source/JavaScript), functions are first class objects. JavaScript also supports closures.

Compare the following with the subsequent Python example.

<syntaxhighlight lang="javascript">
function Accumulator(start) {
  let current = start
  return function (x) {
    return current += x
  }
}
</syntaxhighlight>

An example of this in use:

<syntaxhighlight lang="javascript">
let a = Accumulator(4)
let x = a(5)   // x has value 9
x = a(2)       // x has value 11

let b = Accumulator(42)
x = b(7)       // x has value 49 (current = 49 in closure b)
x = a(7)       // x has value 18 (current = 18 in closure a)
</syntaxhighlight>

== In Julia ==
In [Julia](/source/Julia_(programming_language)), methods are associated with types, so it is possible to make any arbitrary Julia object "callable" by adding methods to its type. (Such "callable" objects are sometimes called "functors.")

An example is this accumulator mutable struct (based on [Paul Graham's](/source/Paul_Graham_(computer_programmer)) study on programming language syntax and clarity):<ref>[http://www.paulgraham.com/accgen.html Accumulator Generator]</ref>

<syntaxhighlight lang="julia-repl">
julia> mutable struct Accumulator
           n::Int
       end

julia> function (acc::Accumulator)(n2)
           acc.n += n2
       end

julia> a = Accumulator(4)
Accumulator(4)

julia> a(5)
9

julia> a(2)
11

julia> b = Accumulator(42)
Accumulator(42)

julia> b(7)
49
</syntaxhighlight>

Such an accumulator can also be implemented using closure:

<syntaxhighlight lang="julia-repl">
julia> function Accumulator(n0)
           n = n0
           function(n2)
               n += n2
           end
       end
Accumulator (generic function with 1 method)

julia> a = Accumulator(4)
(::#1) (generic function with 1 method)

julia> a(5)
9

julia> a(2)
11

julia> b = Accumulator(42)
(::#1) (generic function with 1 method)

julia> b(7)
49
</syntaxhighlight>

== In Lisp and Scheme ==
In Lisp family languages such as [Common Lisp](/source/Common_Lisp), [Scheme](/source/Scheme_(programming_language)), and others, functions are objects, just like strings, vectors, lists, and numbers. A closure-constructing operator creates a ''function object'' from a part of the program: the part of code given as an argument to the operator is part of the function, and so is the lexical environment: the bindings of the lexically visible variables are ''captured'' and stored in the function object, which is more commonly called a [closure](/source/closure_(computer_science)). The captured bindings play the role of ''member variables'', and the code part of the closure plays the role of the ''anonymous member function'', just like operator () in C++.

The closure constructor has the syntax <code>(lambda (parameters ...) code ...)</code>. The <code>(parameters ...)</code> part allows an interface to be declared, so that the function takes the declared parameters. The <code>code ...</code> part consists of expressions that are evaluated when the functor is called.

Many uses of functors in languages like C++ are simply emulations of the missing closure constructor. Since the programmer cannot directly construct a closure, they must define a class that has all of the necessary state variables, and also a member function. Then, construct an instance of that class instead, ensuring that all the member variables are initialized through its constructor. The values are derived precisely from those local variables that ought to be captured directly by a closure.

A function-object using the class system in Common Lisp, no use of closures:

<syntaxhighlight lang="lisp">
(defclass counter ()
  ((value :initarg :value :accessor value-of)))

(defmethod functor-call ((c counter))
  (incf (value-of c)))

(defun make-counter (initial-value)
  (make-instance 'counter :value initial-value))

;;; use the counter:
(defvar *c* (make-counter 10))
(functor-call *c*) --> 11
(functor-call *c*) --> 12
</syntaxhighlight>

Since there is no standard way to make funcallable objects in Common Lisp, we fake it by defining a [generic function](/source/generic_function) called FUNCTOR-CALL. This can be specialized for any class whatsoever. The standard FUNCALL function is not generic; it only takes function objects.

It is this FUNCTOR-CALL generic function that gives us function objects, which are ''a computer programming construct allowing an object to be invoked or called as if it were an ordinary function, usually with the same syntax.'' We have ''almost'' the same syntax: FUNCTOR-CALL instead of FUNCALL. Some Lisps provide ''funcallable'' objects as a simple extension. Making objects callable using the same syntax as functions is a fairly trivial business. Making a function call operator work with different kinds of ''function things'', whether they be class objects or closures is no more complicated than making a + operator that works with different kinds of numbers, such as integers, reals or complex numbers.

Now, a counter implemented using a closure. This is much more brief and direct. The INITIAL-VALUE argument of the MAKE-COUNTER [factory function](/source/factory_function) is captured and used directly. It does not have to be copied into some auxiliary class object through a constructor. It ''is'' the counter. An auxiliary object is created, but that happens ''behind the scenes''.

<syntaxhighlight lang="lisp">
(defun make-counter (value)
  (lambda () (incf value)))

;;; use the counter
(defvar *c* (make-counter 10))
(funcall *c*) ; --> 11
(funcall *c*) ; --> 12
</syntaxhighlight>

Scheme makes closures even simpler, and Scheme code tends to use such [higher-order programming](/source/higher-order_programming) somewhat more idiomatically.

<syntaxhighlight lang="scheme">
(define (make-counter value)
  (lambda () (set! value (+ value 1)) value))
;;; use the counter
(define c (make-counter 10))
(c) ; --> 11
(c) ; --> 12
</syntaxhighlight>

More than one closure can be created in the same lexical environment. A vector of closures, each implementing a specific kind of operation, can quite faithfully emulate an object that has a set of virtual operations. That type of [single dispatch](/source/single_dispatch) object-oriented programming can be done fully with closures.

Thus there exists a kind of tunnel being dug from both sides of the proverbial mountain. Programmers in OOP languages discover function objects by restricting objects to have one ''main'' function to ''do'' that object's functional purpose, and even eliminate its name so that it looks like the object is being called! While programmers who use closures are not surprised that an object is called like a function, they discover that multiple closures sharing the same environment can provide a complete set of abstract operations like a virtual table for [single dispatch](/source/single_dispatch) type OOP.

== In Objective-C ==

In [Objective-C](/source/Objective-C), a function object can be created from the <code>NSInvocation</code> class. Construction of a function object requires a method signature, the target object, and the target selector. Here is an example for creating an invocation to the current object's <code>myMethod</code>:

<syntaxhighlight lang="objc">
// Construct a function object
SEL sel = @selector(myMethod);
NSInvocation* inv = [NSInvocation invocationWithMethodSignature:
                     [self methodSignatureForSelector:sel]];
[inv setTarget:self];
[inv setSelector:sel];

// Do the actual invocation
[inv invoke];
</syntaxhighlight>

An advantage of <code>NSInvocation</code> is that the target object can be modified after creation. A single <code>NSInvocation</code> can be created and then called for each of any number of targets, for instance from an observable object. An <code>NSInvocation</code> can be created from only a protocol, but it is not straightforward. See {{usurped|1=[https://web.archive.org/web/20110227215311/http://www.a-coding.com/2010/10/making-nsinvocations.html here]}}.

== In Perl ==

In [Perl](/source/Perl), a function object can be created either from a class's constructor returning a function closed over the object's instance data, blessed into the class:

<syntaxhighlight lang="perl">
package Acc1;
sub new {
    my $class = shift;
    my $arg = shift;
    my $obj = sub {
        my $num = shift;
        $arg += $num;
    };
    bless $obj, $class;
}
1;
</syntaxhighlight>

or by overloading the <code>&{}</code> operator so that the object can be used as a function:

<syntaxhighlight lang="perl">
package Acc2;
use overload
    '&{}' =>
        sub {
            my $self = shift;
            sub {
                my $num = shift;
                $self->{arg} += $num;
            }
        };

sub new {
    my $class = shift;
    my $arg = shift;
    my $obj = { arg => $arg };
    bless $obj, $class;
}
1;
</syntaxhighlight>

In both cases the function object can be used either using the dereferencing arrow syntax ''$ref->(@arguments)'':

<syntaxhighlight lang="perl">
use Acc1;
my $a = Acc1->new(42);
print $a->(10), "\n";    # prints 52
print $a->(8), "\n";     # prints 60
</syntaxhighlight>
or using the coderef dereferencing syntax ''&$ref(@arguments)'':
<syntaxhighlight lang="perl">
use Acc2;
my $a = Acc2->new(12);
print &$a(10), "\n";     # prints 22
print &$a(8), "\n";      # prints 30
</syntaxhighlight>

== In PHP ==

[PHP](/source/PHP) 5.3+ has [first-class function](/source/first-class_function)s that can be used e.g. as parameter to the {{Code|usort()}} function:

<syntaxhighlight lang="php">
$a = array(3, 1, 4);
usort($a, function ($x, $y) { return $x - $y; });
</syntaxhighlight>

[PHP](/source/PHP) 5.3+, supports also lambda functions and closures.

<syntaxhighlight lang="php">
function Accumulator($start)
{
    $current = $start;
    return function($x) use(&$current)
    {
        return $current += $x;
    };
}
</syntaxhighlight>

An example of this in use:

<syntaxhighlight lang="php">
$a = Accumulator(4);
$x = $a(5);
echo "x = $x<br/>";	// x = 9
$x = $a(2);
echo "x = $x<br/>";	// x = 11
</syntaxhighlight>

It is also possible in PHP 5.3+ to make objects invokable by adding a magic {{Code|__invoke()}} method to their class:<ref name="phpinvoke">[http://php.net/manual/en/language.oop5.magic.php#object.invoke PHP Documentation on Magic Methods]</ref>

<syntaxhighlight lang="php">
class Minus
{
    public function __invoke($x, $y)
    {
        return $x - $y;
    }
}

$a = array(3, 1, 4);
usort($a, new Minus());
</syntaxhighlight>

== In PowerShell ==

In the [Windows PowerShell](/source/Windows_PowerShell) language, a script block is a collection of statements or expressions that can be used as a single unit. A script block can accept arguments and return values. A script block is an instance of a Microsoft [.NET Framework](/source/.NET_Framework) type System.Management.Automation.ScriptBlock.

<syntaxhighlight lang="powershell">
Function Get-Accumulator($x) {
    {
        param($y)
        return $x += $y
    }.GetNewClosure()
}
</syntaxhighlight>
<syntaxhighlight lang="ps1con">
PS C:\> $a = Get-Accumulator 4
PS C:\> & $a 5
9
PS C:\> & $a 2
11
PS C:\> $b = Get-Accumulator 32
PS C:\> & $b 10
42
</syntaxhighlight>

== In Python ==
In [Python](/source/Python_(programming_language)), functions are first-class objects, just like strings, numbers, lists etc. This feature eliminates the need to write a function object in many cases. Any object with a <code>__call__()</code> method can be called using function-call syntax.

An example is this accumulator class (based on [Paul Graham's](/source/Paul_Graham_(computer_programmer)) study on programming language syntax and clarity):<ref>[http://www.paulgraham.com/accgen.html Accumulator Generator]</ref>

<syntaxhighlight lang="python">
class Accumulator:
    def __init__(self, n: int) -> None:
        self.n = n

    def __call__(self, x: int) -> int:
        self.n += x
        return self.n
</syntaxhighlight>

An example of this in use:

<syntaxhighlight lang="python">
a: Accumulator = Accumulator(4)
print(a(5))
# prints: 9
print(a(2))
# prints: 11
b: Accumulator = Accumulator(42)
print(b(7))
# prints: 49
</syntaxhighlight>

Since functions are objects, they can also be defined locally, given attributes, and  returned by other functions,<ref>[https://docs.python.org/3/reference/compound_stmts.html#function-definitions Python reference manual - Function definitions]</ref> as demonstrated in the following example:

<syntaxhighlight lang="python">
def Accumulator(n: int) -> Callable[[int], int]:
    def inc(x: int) -> int:
        nonlocal n: int
        n += x
        return n
    return inc
</syntaxhighlight>

== In Ruby ==
In [Ruby](/source/Ruby_(programming_language)), several objects can be considered function objects, in particular Method and Proc objects. Ruby also has two kinds of objects that can be thought of as semi-function objects: UnboundMethod and block. UnboundMethods must first be bound to an object (thus becoming a Method) before they can be used as a function object. Blocks can be called like function objects, but to be used in any other capacity as an object (e.g. passed as an argument) they must first be converted to a Proc. More recently, symbols (accessed via the literal unary indicator <code>:</code>) can also be converted to <code>Proc</code>s. Using Ruby's unary <code>&</code> operator&mdash;equivalent to calling <code>to_proc</code> on an object, and [assuming that method exists](/source/duck_typing)&mdash;the [Ruby Extensions Project](/source/Ruby_Extensions_Project) [https://web.archive.org/web/20060425104650/http://blogs.pragprog.com/cgi-bin/pragdave.cgi/Tech/Ruby/ToProc.rdoc created a simple hack.]

<syntaxhighlight lang="ruby">
class Symbol
  def to_proc
    proc { |obj, *args| obj.send(self, *args) }
  end
end
</syntaxhighlight>

Now, method <code>foo</code> can be a function object, i.e. a <code>Proc</code>, via <code>&:foo</code> and used via <code>takes_a_functor(&:foo)</code>. <code>Symbol.to_proc</code> was officially added to Ruby on June 11, 2006, during RubyKaigi2006. [https://web.archive.org/web/20060820025032/http://redhanded.hobix.com/cult/symbolTo_procExonerated.html]

Because of the variety of forms, the term Functor is not generally used in Ruby to mean a Function object.
Just a type of dispatch [delegation](/source/delegation_(programming)) introduced by the [https://web.archive.org/web/20070107205748/http://facets.rubyforge.org/ Ruby Facets] project is named as Functor. The most basic definition of which is:

<syntaxhighlight lang="ruby">
class Functor
  def initialize(&func)
    @func = func
  end
  def method_missing(op, *args, &blk)
    @func.call(op, *args, &blk)
  end
end
</syntaxhighlight>

This usage is more akin to that used by functional programming languages, like [ML](/source/ML_(programming_language)), and the original mathematical terminology.

== Other meanings ==

In a more theoretical context a ''function object'' may be considered to be any instance of the class of functions, especially in languages such as [Common Lisp](/source/Common_Lisp) in which functions are [first-class object](/source/first-class_object)s.

The [ML](/source/ML_(programming_language)) family of [functional programming](/source/functional_programming) languages uses the term ''functor'' to represent a [mapping](/source/function_(mathematics)) from modules to modules, or from types to types and is a technique for reusing code. Functors used in this manner are analogous to the original mathematical meaning of [functor](/source/functor) in [category theory](/source/category_theory), or to the use of generic programming in C++, Java or [Ada](/source/Ada_(programming_language)).

In [Haskell](/source/Haskell_(programming_language)), the term ''[functor](/source/Functor_(functional_programming))'' is also used for a concept related to the meaning of ''functor'' in category theory.

In [Prolog](/source/Prolog) and related languages, ''functor'' is a synonym for [function symbol](/source/function_symbol).

== See also ==
* [Callback (computer programming)](/source/Callback_(computer_programming))
* [Closure (computer programming)](/source/Closure_(computer_programming))
* [Function pointer](/source/Function_pointer)
* [Higher-order function](/source/Higher-order_function)
* [Command pattern](/source/Command_pattern)
* [Currying](/source/Currying)

== Notes ==
{{notelist}}

== References ==
{{Reflist}}

== Further reading ==
* David Vandevoorde & Nicolai M Josuttis (2006). ''C++ Templates: The Complete Guide'', {{ISBN|0-201-73484-2}}: Specifically, chapter 22 is devoted to function objects.

== External links ==
* [http://c2.com/cgi/wiki?FunctorObject Description from the Portland Pattern Repository]
* [http://www.two-sdg.demon.co.uk/curbralan/papers/AsynchronousC++.pdf C++ Advanced Design Issues - Asynchronous C++] {{Webarchive|url=https://web.archive.org/web/20200922012516/http://www.two-sdg.demon.co.uk/curbralan/papers/AsynchronousC++.pdf |date=2020-09-22 }} by [Kevlin Henney](/source/Kevlin_Henney)
* [http://www.newty.de/fpt/index.html The Function Pointer Tutorials] by Lars Haendel (2000/2001)
* Article "[https://web.archive.org/web/20041009232434/http://www.cuj.com/documents/s%3D8464/cujcexp0308sutter/ Generalized Function Pointers]" by [Herb Sutter](/source/Herb_Sutter)
* [https://jga.sourceforge.net/ Generic Algorithms for Java]
* [https://web.archive.org/web/20100330073950/http://www.amcgowan.ca/blog/computer-science/php-functors-function-objects-in-php/ PHP Functors - Function Objects in PHP]
* [https://web.archive.org/web/20041013202445/http://www.parashift.com/c++-faq-lite/pointers-to-members.html#faq-33.10 What the heck is a functionoid, and why would I use one?] (C++ FAQ)

{{DEFAULTSORT:Function Object}}
Category:Object (computer science)
Category:Subroutines
Category:Articles with example C code
Category:Articles with example C++ code
Category:Articles with example D code
Category:Articles with example Eiffel code
Category:Articles with example Java code
Category:Articles with example JavaScript code
Category:Articles with example Julia code
Category:Articles with example Lisp (programming language) code
Category:Articles with example Objective-C code
Category:Articles with example Perl code
Category:Articles with example PHP code
Category:Articles with example Python (programming language) code
Category:Articles with example Ruby code

---
Adapted from the Wikipedia article [Function object](https://en.wikipedia.org/wiki/Function_object) by Wikipedia contributors ([contributor history](https://en.wikipedia.org/wiki/Function_object?action=history)). Available under [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). Changes may have been made.
