# The basics

Functions are important building blocks of programs. A function is a named sequence of statements performing a task like computing the summation $\sum_{i=1}^{n}{i}$, for a given positive integer $n > 0$. It’s common that functions have one or several inputs and return one result. For instance, a function to compute $\sum_{i=1}^{n}{i}$ has as input one integer, let us call it $n$. The result returned by the function is also an integer. The C++ function definition computing the summation of the first $n$ natural numbers is given below. Recall that $\sum_{i=1}^{n}{i} = \frac{n(n+1)}{2}$.

The first line of the function’s definition (line $2$) gives the following information about the function:

• The function’s name. Obviously, the name of the function (sum) should be related to the task the function accomplishes.
• The formal arguments (also called formal parameters). The formal arguments indicate which input the function expects to be passed to it so that it can perform its task. For instance, function sum requires as input one integer value which is called n in the function.
• The type of the result returned by the function. Function sum returns an int value.

Between the curly brackets, there’s the function’s body (lines $3$ to $7$) which consist of one or several lines of code describing how the function’s result should be computed.

### Return statements

Functions must have a return-statement (line $6$ of the function above) which state the value returned as output of the function. For instance, return result; states that the value stored in the variable result is returned as output of the function.

Note that the function above could also have been written as follows.

In this case, the function’s body consists solely of a return-statement (line $4$). This statement implies that the expression n * (n - 1)) / 2 is first computed and then its value is returned as output of the function. Note that the result of the expression n * (n - 1)) / 2 is of type int (i.e. the result type of the function).

Keep in mind that when a return-statement is executed the function ends (i.e. no statements within the function are executed after a return has been executed in the function). Consider the following definition of function sum.

Though the function above compiles and computes the correct result, the statement in line $8$ is never executed because a return-statement is executed before and execution of a return ends the execution of any code in the function. Most of the compilers do actually issue a warning message like “unreachable code”. Try to see what compiler warning you get with your compiler (if any). This type of warning should not be ignored and it must be fixed, since it’s a bad programming practice to have code in a function that is never executed.

If you click the button “Run code” under function sum above you can request for clang compiler (used by the Coliru system) to check for unreachable code: add -Werror=unreachable-code to the compiler flags, as shown below.

A function may, however, have several return-statements. See the following function, named absolute_value which returns the absolute value of an input number x (double).

The function starts by testing if x is a negative number. And, if that’s the case then the value of -x is returned (line $3$). Otherwise, the value of x is returned (line $6$). Note that only one of the return-statements is executed, depending on whether x < 0.

Note that if a function is declared to return a value (like function absolute_value declares to return an value of type double) then it’s an error that the function ends without executing a return-statement where a double value (or a value that can be converted to a double) is sent out of the function as its result. Consider, for example, that someone wrote function absolute_value as follows.

double absolute_value(double x) {
if (x < 0) {
return -x;
} else if (x > 0) {
return x;
}

// Error: if x == 0 then no value is returned!!
}


Some compilers report this problem as a warning, not as a compilation error. This is definitely a warning that shouldn’t be ignored and must be fixed. In practice, if the compiled code is executed then the program has undefined-behavior, i.e. it may seem to give the correct result in some systems and it may not-work in other systems.

Flowing off the end of a function is equivalent to executing a return-statement with no value. This results in undefined behavior in a value-returning function.

Probably you have noticed that the main() of any C++-program is also a function and that it returns an int. However, this is a special function for which you don’t need to write any return-statement. The compiler automatically makes sure that the main returns the value 0, if the programmer does not provide a return-statement.

### Function calls

We have so far examined how to define functions. In this section, we discuss how functions can be used in programs.

Consider again the function sum which computes the summation $\sum_{i=1}^{n}{i}$, for a given positive integer $n$.

Assume that we want to write a program that starts by reading a positive integer given by the user, let’s call it a. Then, the program displays the value of $\sum_{i=1}^{a}{i}$. Obviously, the function sum can be useful here. You can find below the program.

An important aspect to have in mind is that the execution of a C++-program starts always with the main.

Therefore, it does not matter how much code or how many functions one writes before the main, the execution of a C++ program always starts with the first statement in the main function.

In line $17$ of the main above there is a function call sum(a), or in other words, the main calls function sum. This means that the main requests that function sum is executed with the input a. The following steps are then automatically performed when a function is called.

1. The formal argument n of function sum receives the value of variable a defined in the main.
2. The statements in the body of function sum are executed (lines $5$ to $7$).
3. When the function sum executes the return-statement (line $7$), the value of variable result is passed to the caller (the main).
4. Execution of the program continues in the caller (line $17$), i.e. the result returned by function sum is written to std::cout.

So, as you can see, calling a function implies that the computer has to perform a rather complicated task with all the four steps described above. Fortunately, all the programmer needed to do was to write the simple code sum(a) to execute function sum with the input a.

It’s common that the function definitions are placed after the main (see below). This better reflects that the execution of a C++-program always starts with the statements in the main and it’s the main that describes the purpose of the whole program. However, in this case, a function declaration must always be placed before a function call. A function declaration consists only of the function’s header, int sum(int n);. We often prefer this way of writing C++-programs.

### Formal and actual arguments

Function sum has one input argument (an int) named n. The input arguments appearing in the function definition are technically called formal arguments (or formal parameters) of the function. For instance, function min (see below) has two formal arguments, named x and y, of type double.

The actual input expressions (or variables) passed to a function in a function call statement are designated as actual arguments (or actual parameters). For instance, line $12$ of the program above has a function call sum(a) and variable a is the actual argument passed to function sum.

Observe the code excerpt below. It contains the function call min(5.0, d). The constant 5.0 and variable d are the actual arguments passed to function min. Thus, the formal arguments of the function min, x and y, receive $5.0$ and the value stored in variable d, respectively.

double d = 20.6;
std::cout << min(5.0, d);


### Examples

The actual arguments in a function call f(exp1, exp2,...) can be any expression with the same type of the corresponding formal arguments of the function f.

Consider the example below.

double d = 20.6;
std::cout << min(d+5, 2*d);


Both expressions d+5 and 2*d evaluate to values of type double and are, therefore, compatible with the type of input expected by the function min.

The following code computes the smallest of three user given numbers.

double d1 = 0.0;
double d2 = 0.0;
double d3 = 0.0;

std::cin >> d1 >> d2 >> d3;

double d4 = min(d1,d2);
std::cout << min(d4, d3);


Note that the expression min(d1, d2) evaluates to a double and that the formal arguments of function min are also of type double (in other words,function min expects two input arguments of type double). We can, therefore, use min(min(d1, d2), d3) to compute the minimum of the three variables d1, d2, and d3.

double d1 = 0.0;
double d2 = 0.0;
double d3 = 0.0;

std::cin >> d1 >> d2 >> d3;

std::cout << min(min(d1,d2), d3);


The example above shows that function calls can also appear as actual arguments in other function calls. Another example can be, for instance, min(std::sqrt(d1), d2).

Next, two examples are presented with complete C++-programs. We strongly encourage you to attempt to write your own code. We stress that you won’t learn coding by just reading and understanding the code the others write for you.

Example $1$: The program below computes $\sum_{i=a}^{b}$, for two user given positive integers $a <= b$. Recall that $\sum_{i=a}^{b}{i} = \sum_{i=1}^{b}{i} - \sum_{i=1}^{a-1}{i}$. A new function is defined to compute $\sum_{i=a}^{b}{i}$ which in turn calls the function sum presented earlier.

Perhaps, you noticed that there are two different functions with same name, sum: one of the functions has one argument, while the other function has two arguments. This is perfectly possible, and often used, in C++-programs. Technically speaking, we say that function sum is overloaded. You can read more about this concept in the section Overloading.

Example $2$: Assume that we want to write a program that computes the trigonometric function $\sin (\theta)$, for a given angle of $\theta \geq 0$ degrees. Though this function exists in the C++-standard library, the idea is that the program makes its own (approximate) computation of the $\sin$-function using a Taylor-series: $\sin (x) = x - \frac{x^3}{3!} + \frac{x^5}{5!} - \frac{x^7}{7!} + \frac{x^9}{9!} - \cdots$. Since the series has an infinite number of terms, one can stop the computation when a term becomes very small, i.e. $\frac{x^i}{i!} <= \delta$ (e.g. $\delta$ is a small constant like $10^{-5}$). Note that $x$ is an angle given in radians, though the program should handle angles in degrees. Therefore, a function to convert angles in degrees to radians is defined in the program.

Recall also that $n!$, for an integer $n>=0$, is the well-known factorial function. A function to compute the factorial is also defined in the program and it returns a long long because the factorial grows very rapidly.

Modify the code above by adding a function that reads and validates the input angle entered by the user. This function should verify that the angle given by the user is non-negative. If the user enters a negative angle then an error message is displayed and the user is requested to enter an angle again. The main function should then call the function.

### Functions without arguments

It’s possible that some C++-functions perform a computation without requiring any input. In this case, the list of function arguments is empty, i.e. no arguments are given between the round brackets. An example is given below of a function that simulates the throw of a dice, called roll_dice.

int roll_dice() {
int dice =  std::rand() % 6 + 1;

return dice;
}

int main() {
// Roll a dice 10 times
for(int i = 1; i <= 10; ++i) {
std::cout << roll_dice() << " ";
}
}


### Functions that return no value

There are also functions that do not return any value. These functions only perform an action, like to display a menu of options, instead of computing a value and returning it.

The return type void is used to indicate that the function does not return any value (see line $1$). For this reason, a function that returns no value is often called a void-function.

Note that it’s not required to have a return-statement in a void-function. Thus, the return in line $14$ of the function above is optional. If the programmer does not write it then the compiler will add a return-statement in the end of the function’s body, automatically.