function signature

In computer science, a type signature or type annotation defines the inputs and outputs of a function, subroutine or method. A type signature includes the number, types, and order of the function's arguments. One important use of a type signature is for function overload resolution, where one particular definition of a function to be called is selected among many overloaded forms.

Examples

C/C++

In C and C++, the type signature is declared by what is commonly known as a function prototype. In C/C++, a function declaration reflects its use; for example, a function pointer with the signature would be called as:

char c;
double d;
int retVal = (*fPtr)(c, d);

Erlang

In Erlang, type signatures may be optionally declared, as:

-spec function_name(type1(), type2(), ...) -> out_type().

For example:

-spec is_even(number()) -> boolean().

Haskell

A type signature in Haskell generally takes the following form:

functionName :: arg1Type -> arg2Type -> ... -> argNType

Notice that the type of the result can be regarded as everything past the first supplied argument. This is a consequence of currying, which is made possible by Haskell's support for first-class functions; this function requires two inputs where one argument is supplied and the function is "curried" to produce a function for the argument not supplied. Thus, calling , where , yields a new function that can be called to produce .

The actual type specifications can consist of an actual type, such as , or a general type variable that is used in parametric polymorphic functions, such as , or , or . So we can write something like:

Since Haskell supports higher-order functions, functions can be passed as arguments. This is written as:

This function takes in a function with type signature and returns data of type out.

Java

In the Java virtual machine, ''internal type signatures'' are used to identify methods and classes at the level of the virtual machine code.

Example: The method is represented in bytecode as .

The signature of the method looks like this:

public static void main(String[] args);

And in the disassembled bytecode, it takes the form of

The method signature for the method contains three modifiers:
* indicates that the method can be called by any object.
* indicates that the method is a class method.
* indicates that the method has no return value.

Signature

A function signature consists of the function prototype. It specifies the general information about a function like the name, scope and parameters. Many programming languages use name mangling in order to pass along more semantic information from the compilers to the linkers. In addition to mangling, there is an excess of information in a function signature (stored internally to most compilers) which is not readily available, but may be accessed.

Understanding the notion of a function signature is an important concept for all computer science studies.
* Modern object orientation techniques make use of interfaces, which are essentially templates made from function signatures.
* C++ uses function overloading with various signatures.

The practice of multiple inheritance requires consideration of the function signatures to avoid unpredictable results. Computer science theory, and the concept of polymorphism in particular, make much use of the concept of function signature.

In the C programming language, a signature is roughly equivalent to its prototype definition.

In the ML family of programming languages, "signature" is used as a keyword referring to a construct of the module system that plays the role of an interface.

Method signature

In computer programming, especially object-oriented programming, a method is commonly identified by its unique method signature, which usually includes the method name and the number, types, and order of its parameters. A method signature is the smallest type of a method.

Examples

C/C++

In C/C++, the method signature is the method name and the number and type of its parameters, but it is possible to have a last parameter that consists of an array of values:

int printf(const char*, ... );

Manipulation of these parameters can be done by using the routines in the standard library header .

In C++, the return type can also follow the parameter list, which is referred to as a trailing return type. The difference is only syntactic; in either case, the resulting signature is identical:

auto printf(const char*... ) -> int;

C#

Similar to the syntax of C, method signatures in C# are composed of a name and the number and type of its parameters, where the last parameter may be an array of values:

void Add(out int sum, params int[] value);
[...]
Add(out sum, 3, 5, 7, 11, -1); // sum

25

Java

In Java (programming language), Java, a method signature is composed of a name and the number, type, and order of its parameters. Return types and thrown exceptions are not considered to be a part of the method signature, nor are the names of parameters; they are ignored by the compiler for checking method uniqueness.

The method signatures help distinguish overloaded methods (methods with the same name) in a class. Return types are not included in overloading. Only method signatures should be used to distinguish overloaded methods.

For example, the following two methods have different signatures:

void doSomething(String[] x); // doSomething(String[])
void doSomething(String x); // doSomething(String)

The following two methods both have the same signature:

int doSomething(int x); // doSomething(int)
void doSomething(int y) throws Exception; // doSomething(int)

Julia

In Julia, function signatures take the following form:

commission(sale::Int, rate::Float64)::Float64

The types in the arguments are used for the multiple dispatch. The return type is validated when the function returns a value, and a runtime exception is raised if the type of the value does not agree with the specified type.

Abstract types are allowed and are encouraged for implementing general behavior that is common to all subtypes. The above function can therefore be rewritten as follows. In this case, the function can accept any Integer and Real subtypes accordingly.

commission(sale::Integer, rate::Real)::Real

Types are completely optional in function arguments. When unspecified, it is equivalent to using the type Any, which is the super-type of all types. It is idiomatic to specify argument types but not return type.

Objective-C

In the Objective-C programming language, method signatures for an object are declared in the interface header file. For example,

- (id)initWithInt:(int)value;

defines a method that returns a general object (an ) and takes one integer argument. Objective-C only requires a type in a signature to be explicit when the type is not ; this signature is equivalent:

- initWithInt:(int)value;

Rust

In Rust, function signatures take the following form:

fn commission(sale: u32, rate: f64) -> f64;

See also

*

References

{{DEFAULTSORT:Type Signature

Type theory
Subroutines