Function pointers are an advanced topic, and this section can be safely skipped or skimmed by those only looking for C++ basics.
Pointer is a variable that holds the address of another variable. Function pointers are similar, except that instead of pointing to variables, they point to functions!
Consider the case of an array:
1
| int Array[5]; |
As you now know, Array is actually a constant pointer to a 5 element array. When we dereference the pointer (either by
*Array or Array[Index]), the appropriate array element is returned.
Now consider the following function:
1
| int foo(); |
If you guessed that foo is actually a constant pointer to a function, you are correct. When a function is called (via the () operator), the function pointer is dereferenced, and execution branches to the function.
Just like it is possible to declare a non-constant pointer to a variable, it’s also possible to declare a non-constant pointer to a function. The syntax for doing so is one of the ugliest things you will ever see:
1
2
| // pFoo is a pointer to a function that takes no arguments and returns an integerint (*pFoo) (); |
The parenthesis around *pFoo are necessary for precedence reasons, as
int *pFoo() would be interpreted as a function named pFoo that takes no parameters and returns a pointer to an integer.
In the above snippet, pFoo is a pointer to a function that has no parameters and returns an integer. pFoo can “point” to any function that matches this signature.
Assigning a function to a function pointer
There are two primary things that you can do with a pointer to a function. First, you can assign a function to it:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| int foo(){}int goo(){}int main(){ int (*pFoo)() = foo; // pFoo points to function foo() pFoo = goo; // pFoo now points to function goo() return 0;} |
One common mistake is to do this:
1
| pFoo = goo(); |
This would actually assign the return value from a call to function goo() to pFoo, which isn’t what we want. We want pFoo to be assigned to function goo, not the return value from goo(). So no parenthesis are needed.
Note that the signature (parameters and return value) of the function pointer must match the signature of the function. Here is an example of this:
1
2
3
4
5
6
7
8
9
10
11
| // function prototypesint foo();double goo();int hoo(int nX);// function pointer assignmentsint (*pFcn1)() = foo; // okayint (*pFcn2)() = goo; // wrong -- return types don't match!double (*pFcn3)() = goo; // okaypFcn1 = hoo; // wrong -- pFcn1 has no parameters, but hoo() doesint (*pFcn3)(int) = hoo; // okay |
Calling a function using a function pointer
The second thing you can do with a function pointer is use it to actually call the function. There are two ways to do this. The first is via explicit dereference:
1
2
3
4
5
6
7
| int foo(int nX){}int (*pFoo)(int) = foo; // assign pFoo to foo()(*pFoo)(nValue); // call function foo(nValue) through pFoo. |
The second way is via implicit dereference:
1
2
3
4
5
6
7
| int foo(int nX){}int (*pFoo)(int) = foo; // assign pFoo to foo()pFoo(nValue); // call function foo(nValue) through pFoo. |
As you can see, the implicit dereference method looks just like a normal function call — which is what you’d expect, since normal function names are pointers to functions anyway! However, some older compilers do not support the implicit dereference method, but all modern compilers should.
Why use pointers to functions?
There are several cases where pointers to function can be of use. One of the most common is the case where you are writing a function to perform a task (such as sorting an array), but you want the user to be able to define how a particular part of that task will be performed (such as whether the array is sorted in ascending or descending order). Let’s take a closer look at this problem as applied specifically to sorting, as an example that can be generalized to other similar problems.
All sorting algorithms work on a similar concept: the sorting algorithm walks through a bunch of numbers, does comparisons on pairs of numbers, and reorders the numbers based on the results of those comparisons. Consequently, by varying the comparison (which can be a function), we can change the way the function sorts without affecting the rest of the sorting code.
Here is our selection sort routine from a previous lesson:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| void SelectionSort(int *anArray, int nSize){ using namespace std; for (int nStartIndex= 0; nStartIndex < nSize; nStartIndex++) { int nBestIndex = nStartIndex; // Search through every element starting at nStartIndex+1 for (int nCurrentIndex = nStartIndex + 1; nCurrentIndex < nSize; nCurrentIndex++) { // Note that we are using the user-defined comparison here if (anArray[nCurrentIndex] < anArray[nBestIndex]) // COMPARISON DONE HERE nBestIndex = nCurrentIndex; } // Swap our start element with our best element swap(anArray[nStartIndex], anArray[nBestIndex]); }} |
Now, let’s replace that comparison with a function to do the comparison. Because our comparison function is going to compare two integers and return a boolean value, it will look something like this:
1
2
3
4
| bool Ascending(int nX, int nY){ return nY > nX;} |
And here’s our selection sort routine using the Ascending() function to do the comparison:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| void SelectionSort(int *anArray, int nSize){ using namespace std; for (int nStartIndex= 0; nStartIndex < nSize; nStartIndex++) { int nBestIndex = nStartIndex; // Search through every element starting at nStartIndex+1 for (int nCurrentIndex = nStartIndex + 1; nCurrentIndex < nSize; nCurrentIndex++) { // Note that we are using the user-defined comparison here if (Ascending(anArray[nCurrentIndex], anArray[nBestIndex])) // COMPARISON DONE HERE nBestIndex = nCurrentIndex; } // Swap our start element with our best element swap(anArray[nStartIndex], anArray[nBestIndex]); }} |
In order to let the caller decide how the sorting will be done, instead of using our own hard-coded comparison function, we’ll allow the caller to provide his own sorting function! This is done via a function pointer.
Because the caller’s comparison function is going to compare two integers and return a boolean value, a pointer to such a function would look something like this:
1
| bool (*pComparison)(int, int); |
So, we’ll allow the caller to pass our sort routine a pointer to their desired comparison function as the third parameter, and then we’ll use the caller’s function to do the comparison.
Here’s a full example of a selection sort that uses a function pointer parameter to do a user-defined comparison, along with an example of how to call it:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
| #include <algorithm> // for swap// Note our user-defined comparison is the third parametervoid SelectionSort(int *anArray, int nSize, bool (*pComparison)(int, int)){ using namespace std; for (int nStartIndex= 0; nStartIndex < nSize; nStartIndex++) { int nBestIndex = nStartIndex; // Search through every element starting at nStartIndex+1 for (int nCurrentIndex = nStartIndex + 1; nCurrentIndex < nSize; nCurrentIndex++) { // Note that we are using the user-defined comparison here if (pComparison(anArray[nCurrentIndex], anArray[nBestIndex])) // COMPARISON DONE HERE nBestIndex = nCurrentIndex; } // Swap our start element with our best element swap(anArray[nStartIndex], anArray[nBestIndex]); }}// Here is a comparison function that sorts in ascending order// (Note: it's exactly the same as the previous Ascending() function)bool Ascending(int nX, int nY){ return nY > nX;}// Here is a comparison function that sorts in descending orderbool Descending(int nX, int nY){ return nY < nX;}// This function prints out the values in the arrayvoid PrintArray(int *pArray, int nSize){ for (int iii=0; iii < nSize; iii++) cout << pArray[iii] << " "; cout << endl;}int main(){ using namespace std; int anArray[9] = { 3, 7, 9, 5, 6, 1, 8, 2, 4 }; // Sort the array in descending order using the Descending() function SelectionSort(anArray, 9, Descending); PrintArray(anArray, 9); // Sort the array in ascending order using the Ascending() function SelectionSort(anArray, 9, Ascending); PrintArray(anArray, 9); return 0;} |
This program produces the result:
Is that cool or what? We’ve given the caller the ability to control how our selection sort does it’s job.
The caller can even define his own “strange” comparison functions:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| bool EvensFirst(int nX, int nY){ // if nX is not even and nY is, nY goes first if ((nX % 2) && !(nY % 2)) return false; // if nX is even and nY is not, nX goes first if (!(nX % 2) && (nY % 2)) return true; // otherwise sort in Ascending order return Ascending(nX, nY);}int main(){ using namespace std; int anArray[9] = { 3, 7, 9, 5, 6, 1, 8, 2, 4 }; SelectionSort(anArray, 9, EvensFirst); PrintArray(anArray, 9); return 0;} |
The above snippet produces the following result:
As you can see, using a function pointer in this context provides a nice way to allow a caller to “hook” it’s own functionality into something you’ve previously written and tested, which helps facilitate code reuse! Previously, if you wanted to sort one array in descending order and another in ascending order, you’d need multiple version of the sort routine. Now you can have one version that can sort any way the caller desires!
Making function pointers pretty with typedef
Let’s face it — the syntax for pointers to functions is ugly. However, typedefs can be used to make pointers to functions look more like regular variables:
1
| typedef bool (*pfcnValidate)(int, int); |
This defines a typedef called “pfcnValidate” that is a pointer to a function that takes two ints and returns a bool.
Now instead of doing this:
1
| bool Validate(int nX, int nY, bool (*pfcn)(int, int)); |
You can do this:
1
| bool Validate(int nX, int nY, pfcnValidate pfcn) |
Which reads a lot nicer!
0 comments: