Constant (computer programming)

Comparison with literals and macros

There are several main ways to express a data value that doesn't change during program execution that are consistent across a wide variety of programming languages. One very basic way is by simply writing a literal number, character, or string into the program code, which is straightforward in C, C++, and similar languages.

In assembly language, literal numbers and characters are done using the "immediate mode" instructions available on most microprocessors. The name "immediate" comes from the values being available immediately from the instruction stream, as opposed to loading them indirectly by looking up a memory address. On the other hand, values longer than the microprocessor's word length, such as strings and arrays, are handled indirectly and assemblers generally provide a "data" pseudo-op to embed such data tables in a program.

Another way is by defining a symbolic macro. Many high-level programming languages, and many assemblers, offer a macro facility where the programmer can define, generally at the beginning of a source file or in a separate definition file, names for different values. A preprocessor then replaces these names with the appropriate values before compiling, resulting in something functionally identical to using literals, with the speed advantages of immediate mode. Because it can be difficult to maintain code where all values are written literally, if a value is used in any repetitive or non-obvious way, it is often named by a macro.

A third way is by declaring and defining a variable as being "constant". A global variable or static variable can be declared (or a symbol defined in assembly) with a keyword qualifier such as const, constexpr, constant, or final (when it is applied to primitive types), meaning that its value will be set at compile time and should not be changeable at runtime. Compilers generally put static constants in the text section of an object file along with the code itself, as opposed to the data section where non-const initialized data is kept. Some compilers can produce a section specifically dedicated to constants. Memory protection can be applied to this area to prevent overwriting of such constants by errant pointers.

These constants differ from literals in a number of ways. Compilers generally place a constant in a single memory location identified by symbol, rather than spread throughout the executable as with a macro. While this precludes the speed advantages of immediate mode, there are advantages in memory efficiency, and debuggers can work with these constants at runtime. Also while macros may be redefined accidentally by conflicting header files in C and C++, conflicting constants are detected at compile time.

Depending upon the language, constants can be untyped or typed. In C and C++, macros provide the former, while const/constexpr provides the latter:

<span id="mwow"></span><span class="cp" id="mwpA">#define PI 3.1415926535</span> <span class="k" id="mwpQ">constexpr</span><span class="w" id="mwpg"> </span><span class="kt" id="mwpw">double</span><span class="w" id="mwqA"> </span><span class="n" id="mwqQ">PI</span><span class="w" id="mwqg"> </span><span class="o" id="mwqw">=</span><span class="w" id="mwrA"> </span><span class="mf" id="mwrQ">3.1415926535</span><span class="p" id="mwrg">;</span><span class="w" id="mwrw"> </span><span class="c1" id="mwsA">// compile-time constant</span> <span class="k" id="mwsQ">const</span><span class="w" id="mwsg"> </span><span class="kt" id="mwsw">double</span><span class="w" id="mwtA"> </span><span class="n" id="mwtQ">pi</span><span class="w" id="mwtg"> </span><span class="o" id="mwtw">=</span><span class="w" id="mwuA"> </span><span class="mf" id="mwuQ">3.1415926535</span><span class="p" id="mwug">;</span><span class="w" id="mwuw"> </span><span class="c1" id="mwvA">// runtime constant</span>

while in Ada, there are universal numeric types that can be used, if desired:

<span id="mwwA"></span><span class="no" id="mwwQ">pi</span> <span class="p" id="mwwg">:</span> <span class="kr" id="mwww">constant</span> <span class="p" id="mwxA">:=</span> <span class="mf" id="mwxQ">3.1415926535</span><span class="p" id="mwxg">;</span> <span class="no" id="mwxw">pi2</span> <span class="p" id="mwyA">:</span> <span class="kr" id="mwyQ">constant</span> <span class="kt" id="mwyg">float</span> <span class="p" id="mwyw">:=</span> <span class="mf" id="mwzA">3.1415926535</span><span class="p" id="mwzQ">;</span>

with the untyped variant being implicitly converted to the appropriate type upon each use.

Dynamically-valued constants

Besides the static constants described above, many procedural languages such as Ada and C++ extend the concept of constantness toward global variables that are created at initialization time, local variables that are automatically created at runtime on the stack or in registers, to dynamically allocated memory that is accessed by pointer, and to parameter lists in function headers.

Dynamically valued constants do not designate a variable as residing in a specific region of memory, nor are the values set at compile time. In C++ code such as

<span id="mw2Q"></span><span class="kt" id="mw2g">float</span><span class="w" id="mw2w"> </span><span class="nf" id="mw3A">func</span><span class="p" id="mw3Q">(</span><span class="k" id="mw3g">const</span><span class="w" id="mw3w"> </span><span class="kt" id="mw4A">float</span><span class="w" id="mw4Q"> </span><span class="n" id="mw4g">myFloat</span><span class="p" id="mw4w">)</span><span class="w" id="mw5A"> </span><span class="p" id="mw5Q">{</span> <span class="w" id="mw5g"> </span><span class="k" id="mw5w">const</span><span class="w" id="mw6A"> </span><span class="kt" id="mw6Q">float</span><span class="w" id="mw6g"> </span><span class="n" id="mw6w">result</span><span class="w" id="mw7A"> </span><span class="o" id="mw7Q">=</span><span class="w" id="mw7g"> </span><span class="n" id="mw7w">someGlobalVariable</span><span class="w" id="mw8A"> </span><span class="o" id="mw8Q">*</span><span class="w" id="mw8g"> </span><span class="n" id="mw8w">someOtherFunction</span><span class="p" id="mw9A">(</span><span class="n" id="mw9Q">myFloat</span><span class="p" id="mw9g">);</span> <span class="w" id="mw9w"> </span><span class="c1" id="mw-A">// ...</span> <span class="p" id="mw-Q">}</span>

the expression that the constant is initialized to are not themselves constant. Use of constantness is not necessary here for program legality or semantic correctness, but has three advantages:

1. It is clear to the reader that the object will not be modified further, once set
2. Attempts to change the value of the object (by later programmers who do not fully understand the program logic) will be rejected by the compiler
3. The compiler may be able to perform code optimizations knowing that the value of the object will not change once created.

Dynamically valued constants originated as a language feature with ALGOL 68. Studies of Ada and C++ code have shown that dynamically valued constants are used infrequently, typically for 1% or less of objects, when they could be used much more, as some 40–50% of local, non-class objects are actually invariant once created. On the other hand, such "immutable variables" tend to be the default in functional languages since they favour programming styles with no side-effect (e.g., recursion) or make most declarations immutable by default, such as ML. Purely functional languages even forbid side-effects entirely.

Constantness is often used in function declarations, as a promise that when an object is passed by reference, the called function will not change it. Depending on the syntax, either a pointer or the object being pointed to may be constant, however normally the latter is desired. Especially in C++ and C, the discipline of ensuring that the proper data structures are constant throughout the program is called const-correctness.

Constant function parameters

In C/C++, it is possible to declare the parameter of a function or method as constant. This is a guarantee that this parameter cannot be inadvertently modified after its initialization by the caller. If the parameter is a pre-defined (built-in) type, it is called by value and cannot be modified. If it is a user-defined type, the variable is the pointer address, which cannot be modified either. However, the content of the object can be modified without limits. Declaring parameters as constants may be a way to signalise that this value should not be changed, but the programmer must keep in mind that checks about modification of an object cannot be done by the compiler.

Besides this feature, it is in C++ also possible to declare a function or method as const. This prevents such functions or methods from modifying anything but local variables.

In C#, the keyword const exists, but does not have the same effect for function parameters, as it is the case in C/C++. There is, however, a way to "stir" the compiler to do make the check, albeit it is a bit tricky.

Object-oriented constants

A constant data structure or object is referred to as "immutable" in object-oriented parlance. An object being immutable confers some advantages in program design. For instance, it may be "copied" simply by copying its pointer or reference, avoiding a time-consuming copy operation and conserving memory.

Object-oriented languages such as C++ extend constantness even further. Individual members of a struct or class may be made const even if the class is not. Conversely, the mutable keyword allows a class member to be changed even if an object was instantiated as const. This may be useful in cases where only data is meant to be const, but some metadata or class-wide information may change.

Even functions can be const in C++. The meaning here is that only a const function may be called for an object instantiated as const; a const function doesn't change any non-mutable data.

C# has both a const and a readonly qualifier; its const is only for compile-time constants, while readonly can be used in constructors and other runtime applications.

In C++, there are four different kinds of const:

• const, the traditional runtime constant
• constexpr, a constant or expression which can be evaluated at compile time
• consteval, which declares that any call to a function must produce a value which is a compile-time expression
• constinit, which declares that the expression has static (constant) initialisation

In Rust, all declarations are constant unless declared mut, which makes them mutable. For compile-time constants, const is used.

Java

Java has a qualifier called final that prevents changing a reference and makes sure it will never point to a different object. This does not prevent changes to the referred object itself. Java's final is basically equivalent to a const pointer in C++. It does not provide the other features of const.

In Java, the qualifier final states that the affected data member or variable is not assignable, as below:

<span id="mwAXA"></span><span class="kd" id="mwAXE">final</span><span class="w" id="mwAXI"> </span><span class="kt" id="mwAXM">int</span><span class="w" id="mwAXQ"> </span><span class="n" id="mwAXU">i</span><span class="w" id="mwAXY"> </span><span class="o" id="mwAXc">=</span><span class="w" id="mwAXg"> </span><span class="mi" id="mwAXk">3</span><span class="p" id="mwAXo">;</span> <span class="n" id="mwAXs">i</span><span class="w" id="mwAXw"> </span><span class="o" id="mwAX0">=</span><span class="w" id="mwAX4"> </span><span class="mi" id="mwAX8">4</span><span class="p" id="mwAYA">;</span><span class="w" id="mwAYE"> </span><span class="c1" id="mwAYI">// Error! Cannot modify a "final" object</span>

It must be decidable by the compilers where the variable with the final marker is initialized, and it must be performed only once, or the class will not compile. Java's final and C++'s const keywords have the same meaning when applied with primitive variables.

<span id="mwAY8"></span><span class="k" id="mwAZA">const</span><span class="w" id="mwAZE"> </span><span class="kt" id="mwAZI">int</span><span class="w" id="mwAZM"> </span><span class="n" id="mwAZQ">i</span><span class="w" id="mwAZU"> </span><span class="o" id="mwAZY">=</span><span class="w" id="mwAZc"> </span><span class="mi" id="mwAZg">3</span><span class="p" id="mwAZk">;</span><span class="w" id="mwAZo"> </span><span class="c1" id="mwAZs">// C++ declaration</span> <span class="n" id="mwAZw">i</span><span class="w" id="mwAZ0"> </span><span class="o" id="mwAZ4">=</span><span class="w" id="mwAZ8"> </span><span class="mi" id="mwAaA">4</span><span class="p" id="mwAaE">;</span><span class="w" id="mwAaI"> </span><span class="c1" id="mwAaM">// Error!</span>

Considering pointers, a final reference in Java means something similar to const pointer in C++. In C++, one can declare a "constant pointer type".

<span id="mwAa0"></span><span class="n" id="mwAa4">Foo</span><span class="o" id="mwAa8">*</span><span class="w" id="mwAbA"> </span><span class="k" id="mwAbE">const</span><span class="w" id="mwAbI"> </span><span class="n" id="mwAbM">bar</span><span class="w" id="mwAbQ"> </span><span class="o" id="mwAbU">=</span><span class="w" id="mwAbY"> </span><span class="n" id="mwAbc">mem_location</span><span class="p" id="mwAbg">;</span><span class="w" id="mwAbk"> </span><span class="c1" id="mwAbo">// const pointer type</span>

Here, bar must be initialised at the time of declaration and cannot be changed again, but what it points is modifiable. I.e. *bar = value is valid. It just can't point to another location. Final references in Java work the same way except that they can be declared uninitialized.

<span id="mwAco"></span><span class="kd" id="mwAcs">final</span><span class="w" id="mwAcw"> </span><span class="n" id="mwAc0">Foo</span><span class="w" id="mwAc4"> </span><span class="n" id="mwAc8">i</span><span class="p" id="mwAdA">;</span><span class="w" id="mwAdE"> </span><span class="c1" id="mwAdI">// a Java declaration</span>

Note: Java does not support pointers. It is because pointers (with restrictions) are the default way of accessing objects in Java, and Java does not use stars to indicate them. For example, i in the last example is a pointer and can be used to access the instance.

One can also declare a pointer to "read-only" data in C++.

<span id="mwAd4"></span><span class="k" id="mwAd8">const</span><span class="w" id="mwAeA"> </span><span class="n" id="mwAeE">Foo</span><span class="o" id="mwAeI">*</span><span class="w" id="mwAeM"> </span><span class="n" id="mwAeQ">bar</span><span class="p" id="mwAeU">;</span>

Here bar can be modified to point anything, anytime; just that pointed value cannot be modified through bar pointer.

There is no equivalent mechanism in Java. Thus there are also no const methods. Const-correctness cannot be enforced in Java, although by use of interfaces and defining a read-only interface to the class and passing this around, one can ensure that objects can be passed around the system in a way that they cannot be modified.

Java collections framework provides a way to create an immutable wrapper of a Collection via Collections.unmodifiableCollection() and similar methods.

A method in Java can be declared "final", meaning that it cannot be overridden in subclasses.

Java reserves the const keyword, but it remains unused currently.

C#

In C#, the qualifier readonly has the same effect on data members that final does in Java and the const does in C++; the modifier const has an effect similar to that of constexpr in C/C++. The other, inheritance-inhibiting effect of Java's final when applied to methods and classes is induced in C# with the aid of the keyword sealed.

Unlike C++, C# does not permit methods and parameters to be marked as const. However one may also pass around read-only subclasses, and the .NET Framework provides some support for converting mutable collections to immutable ones which may be passed as read-only wrappers.

By paradigm

Treatment of constants varies significantly by programming paradigm. Const-correctness is an issue in imperative languages like C++ because by default name bindings typically create variables, which can vary, as the name suggests, and thus if one wishes to mark a binding as constant this requires some additional indication. In other programming language paradigms related issues arise, with some analogs to const-correctness found.

In functional programming, data are typically constant by default, rather than variable by default. Instead of assigning a value to a variable (a storage space with a name and potentially variable value), one creates a binding of a name to a value, such as by the let construct in many dialects of Lisp. In some functional languages, particularly multiparadigm ones such as Common Lisp, modifying data is commonplace, while in others it is avoided or considered exceptional; this is the case for Scheme (another Lisp dialect), which uses the set! construct to modify data, with the ! exclamation point drawing attention to this. Such languages achieve the goals of const-correctness by default, drawing attention to modification rather than constantness.

In a number of object-oriented languages, there is the concept of an immutable object, which is particularly used for basic types like strings; notable examples include Java, JavaScript, Python, and C#. These languages vary in whether user-defined types can be marked as immutable, and may allow particular fields (attributes) of an object or type to be marked as immutable.

In some multiparadigm languages that allow both object-oriented and functional styles, both of these features may be combined. For example, in OCaml object fields are immutable by default and must be explicitly marked with the keyword mutable to be mutable, while in Scala, bindings are explicitly immutable when defined with val for "value" and explicitly mutable when defined with var for "variable".

Naming conventions

Naming conventions for constants vary. Some simply name them as they would any other variable. Others use capitals and underscores for constants in a way similar to their traditional use for symbolic macros, such as SOME_CONSTANT. In Hungarian notation, a "k" prefix signifies constants as well as macros and enumerated types.

One enforced convention is that in Ruby, any variable that begins with a capital letter is considered a constant, including class names.