any is one of the newest features of C++17 that provides a type-safe container to store single value of any type. In layman’s terms, it is a container which allows one to store any value in it without worrying about the type safety. It acts as an extension to C++ by mimicking behaviour similar to an object type in .NET/Java or void* type in C language . It has been designed based on boost::any and is available in “any” header file.
Syntax:
any var= value/object;
where value is something like “17” or “Hello World”
Initialisation of any:
any can be constructed in three different ways using:
- Copy Initialization
Syntax:
any variable_name = object/value;
- Parameterized constructor / brace initializer.
Syntax:
any variable_name ( object/value);
- Using the assignment operator
Syntax:
any variable_name;
variable_name= object/value;
Converting any_var value into its original type:
One must use any_cast<type>( any_var ) to convert any_var value into its original type. If a stored value has a type other than the one trying to cast to, then a “bad_any_cast” exception will be thrown by the compiler.
Note: The type during the cast must exactly be same as the original type. There is no automatic promotion or demotion during the cast. Hence special care must be taken while casting the value to its original type.
A Simple Example ( Illustrates the construction / reading values of any)
#include <any>
#include <iostream>
#include <string>
using namespace std;
int main()
{
try {
any value = 42;
cout << "\n Value: "
<< any_cast<int>(value);
value = "Hello World";
cout << "\n Value: "
<< any_cast<const char*>(value);
any val(19.0);
cout << " \n Value: "
<< any_cast<double>(val);
any val_brace{ string("Brace Initialisation") };
cout << " \n Value: "
<< any_cast<string>(val_brace);
}
catch (bad_any_cast& e) {
cout << "\n"
<< e.what();
}
return 0;
}
|
Output:
Value: 42
Value: Hello World
Value: 19
Value: Brace Initialisation
Member functions:
- emplace : Changes the contained object, constructing the new object directly
- reset : Destroys the contained object ( Calls the destructor of the object)
- has_value : Checks if the “any_variable” holds a value within it
- type : Returns the type id of the contained value
Lets see the methods one by one in detail:
Uses of any
Typical uses include
- In Libraries, When a library type has to hold or pass anything without knowing the set of available types.
- Message Passing
- Implementing Parser Libraries for ex. JSON parser
- User Interface: controls might hold anything
- Entity component system.
One of the main benefits of any is its viable substitution with void*. void* has limited capability( Only stores pointer types) and is considered as an unsafe pattern.
Error Handling:
There are two options regarding error handling for any class:
- Using Exceptions: bad_any_cast is the exception thrown by the value-returning forms of any_cast on type-mismatch.
Example:
#include <any>
#include <iostream>
#include <string>
int main()
{
try {
any var = 12.0f;
cout << " \n Value: "
<< any_cast<double>(var);
}
catch (bad_any_cast& e) {
cout << "\n"
<< e.what();
}
return 0;
}
|
Output
Value:
bad any_cast
-
Returning a Pointer: Returning a pointer is useful when the exception mechanism has been disabled in the compiler. This particular overload of any_cast returns the pointer to the contained object if the cast was successful and returns nullptr.
Example:
#include <any>
#include <iostream>
#include <string>
using namespace std;
int main()
{
any var = 12.0f;
auto* tval = any_cast<float>(&var);
if (!tval) {
cout << " \n Bad_any_cast ";
}
else {
cout << " \n Value: "
<< *tval;
}
return 0;
}
|
Output:
Value: 12
Memory Considerations
Although any gives a lot of flexibility with the language, the main issue with any is extra dynamic memory allocations. As the container is not aware of object contained dynamic allocation becomes a must for any.
But according to the standard, Implementations should avoid the use of dynamically allocated memory for a small contained value. Example: where the object constructed is holding only an int. Such small-object optimisation shall only be applied to types T for which is_nothrow_move_constructible_v true.
What this typically means is that the compiler must use small buffer optimization ( SBO) in which a certain amount of memory has to be reserved for the type to be contained.
From the table above, one can see that reserved memory for SBO in some cases could go upto 64 bytes! ( MSVC-64 bit). This means that each object of any would require 64 bytes of memory reserved even if the object is small which is a considerable memory overhead.
Although any is a very powerful feature in C++. It comes with a considerable amount of overhead in terms of memory.
Similar Reads
std::string class in C++
C++ has in its definition a way to represent a sequence of characters as an object of the class. This class is called std:: string. The string class stores the characters as a sequence of bytes with the functionality of allowing access to the single-byte character.String vs Character ArrayStringChar
8 min read
Anonymous classes in C++
Anonymous class is a class which has no name given to it. C++ supports this feature. These classes cannot have a constructor but can have a destructor. These classes can neither be passed as arguments to functions nor can be used as return values from functions. Examples to illustrate Anonymous Clas
3 min read
is_class template in C++
The std::is_class template of C++ STL is used to check whether the given type is class or not. It returns a boolean value showing the same. Syntax: template <class T> struct is_class; Parameter: This template accepts single parameter T (Trait class) to check whether T is a class or not. Return
2 min read
bitset any() in C++ STL
The bitset::any() is an inbuilt function in C++ STL which returns True if at least one bit is set in a number. It returns False if all the bits are not set or if the number is zero. Syntax: bool any() Parameter: The function does not accepts any parameter. Return Value: The function returns a boolea
2 min read
Trivial classes in C++
When a class or struct in C++ has compiler-provided or explicitly defaulted special member functions, then it is a trivial type. It occupies a contiguous memory area. It can have members with different access specifiers. Trivial types have a trivial default constructor, trivial copy constructor, tri
1 min read
C++ Classes and Objects
In C++, classes and objects are the basic building block that leads to Object-Oriented programming in C++. We will learn about C++ classes, objects, look at how they work and how to implement them in our C++ program.C++ ClassesA class is a user-defined data type, which holds its own data members and
9 min read
any_of() Function in C++ STL
any_of() is the C++ function defined in <algorithm> library in STL. This function determines whether even one element in a given range satisfies a specified criterion. If at least one element meets the property, then it returns true; otherwise, it returns false. Also if the range is empty then
2 min read
Friend Class and Function in C++
In C++, friend functions and friend classes are concepts that allow certain functions or classes to access the private and protected members of another class. These are useful concepts in such situations where you need to give a function or another class access to internal data, while still keeping
5 min read
Local Classes in C++
A class declared inside a function becomes local to that function and is called Local Class in C++. A local class name can only be used locally i.e., inside the function and not outside it.The methods of a local class must be defined inside it only.A local class can have static functions but, not st
6 min read
std::all_of() in C++
The C++ function is defined in <algorithm> library in STL. This function operates on whole range of array elements and can save time to run a loop to check each elements one by one. It checks for a given property on every element and returns true when each element in range satisfies specified
2 min read