C++ Notes For Professionals
C++ Notes For Professionals
C++
Notes for Professionals
600+ pages
of professional hints and tricks
Disclaimer
GoalKicker.com This is an unocial free book created for educational purposes and is
not aliated with ocial C++ group(s) or company(s).
Free Programming Books All trademarks and registered trademarks are
the property of their respective owners
Contents
About ................................................................................................................................................................................... 1
Chapter 1: Getting started with C++ .................................................................................................................... 2
Section 1.1: Hello World ................................................................................................................................................. 2
Section 1.2: Comments .................................................................................................................................................. 3
Section 1.3: The standard C++ compilation process .................................................................................................. 5
Section 1.4: Function ...................................................................................................................................................... 5
Section 1.5: Visibility of function prototypes and declarations ................................................................................. 8
Section 1.6: Preprocessor .............................................................................................................................................. 9
Chapter 2: Literals ...................................................................................................................................................... 11
Section 2.1: this ............................................................................................................................................................. 11
Section 2.2: Integer literal ........................................................................................................................................... 11
Section 2.3: true ........................................................................................................................................................... 12
Section 2.4: false .......................................................................................................................................................... 13
Section 2.5: nullptr ....................................................................................................................................................... 13
Chapter 3: Inline variables ..................................................................................................................................... 14
Section 3.1: Defining a static data member in the class definition ......................................................................... 14
Chapter 4: operator precedence ....................................................................................................................... 15
Section 4.1: Logical && and || operators: short-circuit ............................................................................................. 15
Section 4.2: Unary Operators .................................................................................................................................... 16
Section 4.3: Arithmetic operators .............................................................................................................................. 16
Section 4.4: Logical AND and OR operators ............................................................................................................ 17
Chapter 5: Floating Point Arithmetic ................................................................................................................ 18
Section 5.1: Floating Point Numbers are Weird ........................................................................................................ 18
Chapter 6: Bit Operators ........................................................................................................................................ 19
Section 6.1: | - bitwise OR ............................................................................................................................................ 19
Section 6.2: ^ - bitwise XOR (exclusive OR) .............................................................................................................. 19
Section 6.3: & - bitwise AND ....................................................................................................................................... 21
Section 6.4: << - left shift ............................................................................................................................................. 21
Section 6.5: >> - right shift .......................................................................................................................................... 22
Chapter 7: Bit Manipulation ................................................................................................................................... 24
Section 7.1: Remove rightmost set bit ....................................................................................................................... 24
Section 7.2: Set all bits ................................................................................................................................................ 24
Section 7.3: Toggling a bit .......................................................................................................................................... 24
Section 7.4: Checking a bit ......................................................................................................................................... 24
Section 7.5: Counting bits set ..................................................................................................................................... 25
Section 7.6: Check if an integer is a power of 2 ....................................................................................................... 26
Section 7.7: Setting a bit ............................................................................................................................................. 26
Section 7.8: Clearing a bit ........................................................................................................................................... 26
Section 7.9: Changing the nth bit to x ....................................................................................................................... 26
Section 7.10: Bit Manipulation Application: Small to Capital Letter ........................................................................ 27
Chapter 8: Bit fields ................................................................................................................................................... 28
Section 8.1: Declaration and Usage ........................................................................................................................... 28
Chapter 9: Arrays ....................................................................................................................................................... 29
Section 9.1: Array initialization .................................................................................................................................... 29
Section 9.2: A fixed size raw array matrix (that is, a 2D raw array) ...................................................................... 30
Section 9.3: Dynamically sized raw array ................................................................................................................. 30
Section 9.4: Array size: type safe at compile time ................................................................................................... 31
Section 9.5: Expanding dynamic size array by using std::vector ........................................................................... 32
Section 9.6: A dynamic size matrix using std::vector for storage ........................................................................... 33
Chapter 10: Iterators ................................................................................................................................................. 36
Section 10.1: Overview ................................................................................................................................................. 36
Section 10.2: Vector Iterator ....................................................................................................................................... 39
Section 10.3: Map Iterator ........................................................................................................................................... 39
Section 10.4: Reverse Iterators ................................................................................................................................... 40
Section 10.5: Stream Iterators .................................................................................................................................... 41
Section 10.6: C Iterators (Pointers) ............................................................................................................................ 41
Section 10.7: Write your own generator-backed iterator ........................................................................................ 42
Chapter 11: Basic input/output in c++ .............................................................................................................. 44
Section 11.1: user input and standard output ............................................................................................................ 44
Chapter 12: Loops ....................................................................................................................................................... 45
Section 12.1: Range-Based For ................................................................................................................................... 45
Section 12.2: For loop .................................................................................................................................................. 47
Section 12.3: While loop ............................................................................................................................................... 49
Section 12.4: Do-while loop ......................................................................................................................................... 50
Section 12.5: Loop Control statements : Break and Continue ................................................................................. 51
Section 12.6: Declaration of variables in conditions ................................................................................................. 52
Section 12.7: Range-for over a sub-range ................................................................................................................ 53
Chapter 13: File I/O .................................................................................................................................................... 55
Section 13.1: Writing to a file ....................................................................................................................................... 55
Section 13.2: Opening a file ......................................................................................................................................... 55
Section 13.3: Reading from a file ................................................................................................................................ 56
Section 13.4: Opening modes ..................................................................................................................................... 58
Section 13.5: Reading an ASCII file into a std::string ................................................................................................. 59
Section 13.6: Writing files with non-standard locale settings .................................................................................. 60
Section 13.7: Checking end of file inside a loop condition, bad practice? .............................................................. 61
Section 13.8: Flushing a stream .................................................................................................................................. 62
Section 13.9: Reading a file into a container ............................................................................................................. 62
Section 13.10: Copying a file ........................................................................................................................................ 63
Section 13.11: Closing a file .......................................................................................................................................... 63
Section 13.12: Reading a `struct` from a formatted text file .................................................................................... 64
Chapter 14: C++ Streams ........................................................................................................................................ 66
Section 14.1: String streams ........................................................................................................................................ 66
Section 14.2: Printing collections with iostream ........................................................................................................ 67
Chapter 15: Stream manipulators ...................................................................................................................... 69
Section 15.1: Stream manipulators ............................................................................................................................. 69
Section 15.2: Output stream manipulators ............................................................................................................... 74
Section 15.3: Input stream manipulators ................................................................................................................... 76
Chapter 16: Flow Control ......................................................................................................................................... 78
Section 16.1: case ......................................................................................................................................................... 78
Section 16.2: switch ...................................................................................................................................................... 78
Section 16.3: catch ....................................................................................................................................................... 78
Section 16.4: throw ....................................................................................................................................................... 79
Section 16.5: default ..................................................................................................................................................... 80
Section 16.6: try ............................................................................................................................................................ 80
Section 16.7: if ............................................................................................................................................................... 80
Section 16.8: else .......................................................................................................................................................... 81
Section 16.9: Conditional Structures: if, if..else ........................................................................................................... 81
Section 16.10: goto ....................................................................................................................................................... 82
Section 16.11: Jump statements : break, continue, goto, exit ................................................................................... 82
Section 16.12: return ..................................................................................................................................................... 85
Chapter 17: Metaprogramming ........................................................................................................................... 87
Section 17.1: Calculating Factorials ............................................................................................................................ 87
Section 17.2: Iterating over a parameter pack ......................................................................................................... 89
Section 17.3: Iterating with std::integer_sequence ................................................................................................... 90
Section 17.4: Tag Dispatching .................................................................................................................................... 91
Section 17.5: Detect Whether Expression is Valid ..................................................................................................... 91
Section 17.6: If-then-else ............................................................................................................................................. 93
Section 17.7: Manual distinction of types when given any type T .......................................................................... 93
Section 17.8: Calculating power with C++11 (and higher) ......................................................................................... 94
Section 17.9: Generic Min/Max with variable argument count ............................................................................... 95
Chapter 18: const keyword .................................................................................................................................... 96
Section 18.1: Avoiding duplication of code in const and non-const getter methods ............................................ 96
Section 18.2: Const member functions ...................................................................................................................... 97
Section 18.3: Const local variables ............................................................................................................................. 98
Section 18.4: Const pointers ........................................................................................................................................ 98
Chapter 19: mutable keyword ............................................................................................................................ 100
Section 19.1: mutable lambdas ................................................................................................................................. 100
Section 19.2: non-static class member modifier .................................................................................................... 100
Chapter 20: Friend keyword ............................................................................................................................... 102
Section 20.1: Friend function .................................................................................................................................... 102
Section 20.2: Friend method .................................................................................................................................... 103
Section 20.3: Friend class ......................................................................................................................................... 103
Chapter 21: Type Keywords ................................................................................................................................. 105
Section 21.1: class ....................................................................................................................................................... 105
Section 21.2: enum ..................................................................................................................................................... 106
Section 21.3: struct ..................................................................................................................................................... 107
Section 21.4: union ..................................................................................................................................................... 107
Chapter 22: Basic Type Keywords ................................................................................................................... 109
Section 22.1: char ....................................................................................................................................................... 109
Section 22.2: char16_t ............................................................................................................................................... 109
Section 22.3: char32_t .............................................................................................................................................. 109
Section 22.4: int ......................................................................................................................................................... 109
Section 22.5: void ...................................................................................................................................................... 109
Section 22.6: wchar_t ............................................................................................................................................... 110
Section 22.7: float ...................................................................................................................................................... 110
Section 22.8: double .................................................................................................................................................. 110
Section 22.9: long ...................................................................................................................................................... 110
Section 22.10: short ................................................................................................................................................... 111
Section 22.11: bool ...................................................................................................................................................... 111
Chapter 23: Variable Declaration Keywords .............................................................................................. 112
Section 23.1: decltype ................................................................................................................................................ 112
Section 23.2: const .................................................................................................................................................... 112
Section 23.3: volatile ................................................................................................................................................. 113
Section 23.4: signed .................................................................................................................................................. 113
Section 23.5: unsigned .............................................................................................................................................. 113
Chapter 24: Keywords ........................................................................................................................................... 115
Section 24.1: asm ....................................................................................................................................................... 115
Section 24.2: Dierent keywords ............................................................................................................................. 115
Section 24.3: typename ............................................................................................................................................ 119
Section 24.4: explicit .................................................................................................................................................. 120
Section 24.5: sizeof .................................................................................................................................................... 120
Section 24.6: noexcept .............................................................................................................................................. 121
Chapter 25: Returning several values from a function ........................................................................ 123
Section 25.1: Using std::tuple .................................................................................................................................... 123
Section 25.2: Structured Bindings ............................................................................................................................ 124
Section 25.3: Using struct ......................................................................................................................................... 125
Section 25.4: Using Output Parameters .................................................................................................................. 126
Section 25.5: Using a Function Object Consumer .................................................................................................. 127
Section 25.6: Using std::pair ..................................................................................................................................... 128
Section 25.7: Using std::array ................................................................................................................................... 128
Section 25.8: Using Output Iterator ......................................................................................................................... 128
Section 25.9: Using std::vector ................................................................................................................................. 129
Chapter 26: Polymorphism .................................................................................................................................. 130
Section 26.1: Define polymorphic classes ............................................................................................................... 130
Section 26.2: Safe downcasting ............................................................................................................................... 131
Section 26.3: Polymorphism & Destructors ............................................................................................................ 132
Chapter 27: References ......................................................................................................................................... 134
Section 27.1: Defining a reference ........................................................................................................................... 134
Chapter 28: Value and Reference Semantics ............................................................................................ 135
Section 28.1: Definitions ............................................................................................................................................ 135
Section 28.2: Deep copying and move support ..................................................................................................... 135
Chapter 29: C++ function "call by value" vs. "call by reference" ..................................................... 139
Section 29.1: Call by value ........................................................................................................................................ 139
Chapter 30: Copying vs Assignment ............................................................................................................... 141
Section 30.1: Assignment Operator ......................................................................................................................... 141
Section 30.2: Copy Constructor ............................................................................................................................... 141
Section 30.3: Copy Constructor Vs Assignment Constructor ............................................................................... 142
Chapter 31: Pointers ................................................................................................................................................ 144
Section 31.1: Pointer Operations ............................................................................................................................... 144
Section 31.2: Pointer basics ...................................................................................................................................... 144
Section 31.3: Pointer Arithmetic ................................................................................................................................ 146
Chapter 32: Pointers to members .................................................................................................................... 148
Section 32.1: Pointers to static member functions ................................................................................................. 148
Section 32.2: Pointers to member functions .......................................................................................................... 148
Section 32.3: Pointers to member variables ........................................................................................................... 149
Section 32.4: Pointers to static member variables ................................................................................................ 149
Chapter 33: The This Pointer ............................................................................................................................... 151
Section 33.1: this Pointer ........................................................................................................................................... 151
Section 33.2: Using the this Pointer to Access Member Data ............................................................................... 153
Section 33.3: Using the this Pointer to Dierentiate Between Member Data and Parameters ........................ 153
Section 33.4: this Pointer CV-Qualifiers ................................................................................................................... 154
Section 33.5: this Pointer Ref-Qualifiers .................................................................................................................. 157
Chapter 34: Smart Pointers ................................................................................................................................ 159
Section 34.1: Unique ownership (std::unique_ptr) .................................................................................................. 159
Section 34.2: Sharing ownership (std::shared_ptr) ................................................................................................ 160
Section 34.3: Sharing with temporary ownership (std::weak_ptr) ....................................................................... 162
Section 34.4: Using custom deleters to create a wrapper to a C interface ........................................................ 164
Section 34.5: Unique ownership without move semantics (auto_ptr) ................................................................. 165
Section 34.6: Casting std::shared_ptr pointers ....................................................................................................... 167
Section 34.7: Writing a smart pointer: value_ptr ................................................................................................... 167
Section 34.8: Getting a shared_ptr referring to this .............................................................................................. 169
Chapter 35: Classes/Structures ........................................................................................................................ 171
Section 35.1: Class basics .......................................................................................................................................... 171
Section 35.2: Final classes and structs .................................................................................................................... 171
Section 35.3: Access specifiers ................................................................................................................................. 172
Section 35.4: Inheritance .......................................................................................................................................... 173
Section 35.5: Friendship ............................................................................................................................................ 175
Section 35.6: Virtual Inheritance .............................................................................................................................. 176
Section 35.7: Private inheritance: restricting base class interface ....................................................................... 177
Section 35.8: Accessing class members ................................................................................................................. 178
Section 35.9: Member Types and Aliases ............................................................................................................... 179
Section 35.10: Nested Classes/Structures ............................................................................................................... 182
Section 35.11: Unnamed struct/class ....................................................................................................................... 187
Section 35.12: Static class members ........................................................................................................................ 188
Section 35.13: Multiple Inheritance ........................................................................................................................... 192
Section 35.14: Non-static member functions .......................................................................................................... 193
Chapter 36: Function Overloading ................................................................................................................... 196
Section 36.1: What is Function Overloading? .......................................................................................................... 196
Section 36.2: Return Type in Function Overloading .............................................................................................. 197
Section 36.3: Member Function cv-qualifier Overloading ..................................................................................... 197
Chapter 37: Operator Overloading ................................................................................................................. 200
Section 37.1: Arithmetic operators ........................................................................................................................... 200
Section 37.2: Array subscript operator ................................................................................................................... 201
Section 37.3: Conversion operators ......................................................................................................................... 202
Section 37.4: Complex Numbers Revisited ............................................................................................................. 203
Section 37.5: Named operators ............................................................................................................................... 207
Section 37.6: Unary operators ................................................................................................................................. 209
Section 37.7: Comparison operators ....................................................................................................................... 210
Section 37.8: Assignment operator ......................................................................................................................... 211
Section 37.9: Function call operator ........................................................................................................................ 211
Section 37.10: Bitwise NOT operator ....................................................................................................................... 212
Section 37.11: Bit shift operators for I/O .................................................................................................................. 212
Chapter 38: Function Template Overloading ............................................................................................ 214
Section 38.1: What is a valid function template overloading? .............................................................................. 214
Chapter 39: Virtual Member Functions .......................................................................................................... 215
Section 39.1: Final virtual functions .......................................................................................................................... 215
Section 39.2: Using override with virtual in C++11 and later .................................................................................. 215
Section 39.3: Virtual vs non-virtual member functions ......................................................................................... 216
Section 39.4: Behaviour of virtual functions in constructors and destructors .................................................... 217
Section 39.5: Pure virtual functions ......................................................................................................................... 218
Chapter 40: Inline functions ............................................................................................................................... 221
Section 40.1: Non-member inline function definition ............................................................................................. 221
Section 40.2: Member inline functions .................................................................................................................... 221
Section 40.3: What is function inlining? ................................................................................................................... 221
Section 40.4: Non-member inline function declaration ........................................................................................ 222
Chapter 41: Special Member Functions ......................................................................................................... 223
Section 41.1: Default Constructor ............................................................................................................................. 223
Section 41.2: Destructor ............................................................................................................................................ 225
Section 41.3: Copy and swap .................................................................................................................................... 226
Section 41.4: Implicit Move and Copy ...................................................................................................................... 228
Chapter 42: Non-Static Member Functions ................................................................................................ 229
Section 42.1: Non-static Member Functions ........................................................................................................... 229
Section 42.2: Encapsulation ..................................................................................................................................... 230
Section 42.3: Name Hiding & Importing .................................................................................................................. 230
Section 42.4: Virtual Member Functions ................................................................................................................. 232
Section 42.5: Const Correctness .............................................................................................................................. 234
Chapter 43: Constant class member functions ........................................................................................ 236
Section 43.1: constant member function ................................................................................................................. 236
Chapter 44: C++ Containers ............................................................................................................................... 237
Section 44.1: C++ Containers Flowchart .................................................................................................................. 237
Chapter 45: Namespaces ..................................................................................................................................... 238
Section 45.1: What are namespaces? ..................................................................................................................... 238
Section 45.2: Argument Dependent Lookup .......................................................................................................... 239
Section 45.3: Extending namespaces ...................................................................................................................... 240
Section 45.4: Using directive .................................................................................................................................... 240
Section 45.5: Making namespaces .......................................................................................................................... 241
Section 45.6: Unnamed/anonymous namespaces ............................................................................................... 242
Section 45.7: Compact nested namespaces .......................................................................................................... 242
Section 45.8: Namespace alias ................................................................................................................................ 242
Section 45.9: Inline namespace ............................................................................................................................... 243
Section 45.10: Aliasing a long namespace .............................................................................................................. 245
Section 45.11: Alias Declaration scope ..................................................................................................................... 245
Chapter 46: Header Files ...................................................................................................................................... 247
Section 46.1: Basic Example ..................................................................................................................................... 247
Section 46.2: Templates in Header Files ................................................................................................................. 248
Chapter 47: Using declaration .......................................................................................................................... 249
Section 47.1: Importing names individually from a namespace ........................................................................... 249
Section 47.2: Redeclaring members from a base class to avoid name hiding .................................................. 249
Section 47.3: Inheriting constructors ....................................................................................................................... 249
Chapter 48: std::string .......................................................................................................................................... 251
Section 48.1: Tokenize ............................................................................................................................................... 251
Section 48.2: Conversion to (const) char* .............................................................................................................. 252
Section 48.3: Using the std::string_view class ........................................................................................................ 252
Section 48.4: Conversion to std::wstring ................................................................................................................. 253
Section 48.5: Lexicographical comparison ............................................................................................................. 254
Section 48.6: Trimming characters at start/end ................................................................................................... 255
Section 48.7: String replacement ............................................................................................................................. 256
Section 48.8: Converting to std::string ..................................................................................................................... 257
Section 48.9: Splitting ................................................................................................................................................ 258
Section 48.10: Accessing a character ...................................................................................................................... 259
Section 48.11: Checking if a string is a prefix of another ....................................................................................... 259
Section 48.12: Looping through each character .................................................................................................... 260
Section 48.13: Conversion to integers/floating point types .................................................................................. 260
Section 48.14: Concatenation ................................................................................................................................... 261
Section 48.15: Converting between character encodings ..................................................................................... 262
Section 48.16: Finding character(s) in a string ....................................................................................................... 263
Chapter 49: std::array ........................................................................................................................................... 264
Section 49.1: Initializing an std::array ....................................................................................................................... 264
Section 49.2: Element access ................................................................................................................................... 265
Section 49.3: Iterating through the Array ............................................................................................................... 267
Section 49.4: Checking size of the Array ................................................................................................................ 267
Section 49.5: Changing all array elements at once ............................................................................................... 267
Chapter 50: std::vector ......................................................................................................................................... 268
Section 50.1: Accessing Elements ............................................................................................................................ 268
Section 50.2: Initializing a std::vector ...................................................................................................................... 270
Section 50.3: Deleting Elements .............................................................................................................................. 271
Section 50.4: Iterating Over std::vector ................................................................................................................... 273
Section 50.5: vector<bool>: The Exception To So Many, So Many Rules ............................................................ 275
Section 50.6: Inserting Elements .............................................................................................................................. 276
Section 50.7: Using std::vector as a C array ........................................................................................................... 277
Section 50.8: Finding an Element in std::vector ...................................................................................................... 278
Section 50.9: Concatenating Vectors ...................................................................................................................... 279
Section 50.10: Matrices Using Vectors .................................................................................................................... 280
Section 50.11: Using a Sorted Vector for Fast Element Lookup ............................................................................ 281
Section 50.12: Reducing the Capacity of a Vector ................................................................................................. 282
Section 50.13: Vector size and capacity .................................................................................................................. 282
Section 50.14: Iterator/Pointer Invalidation ............................................................................................................ 284
Section 50.15: Find max and min Element and Respective Index in a Vector .................................................... 285
Section 50.16: Converting an array to std::vector .................................................................................................. 285
Section 50.17: Functions Returning Large Vectors ................................................................................................ 286
Chapter 51: std::map ............................................................................................................................................... 288
Section 51.1: Accessing elements ............................................................................................................................. 288
Section 51.2: Inserting elements ............................................................................................................................... 289
Section 51.3: Searching in std::map or in std::multimap ......................................................................................... 290
Section 51.4: Initializing a std::map or std::multimap .............................................................................................. 291
Section 51.5: Checking number of elements ........................................................................................................... 292
Section 51.6: Types of Maps ..................................................................................................................................... 292
Section 51.7: Deleting elements ................................................................................................................................ 293
Section 51.8: Iterating over std::map or std::multimap .......................................................................................... 294
Section 51.9: Creating std::map with user-defined types as key .......................................................................... 294
Chapter 52: std::optional ...................................................................................................................................... 296
Section 52.1: Using optionals to represent the absence of a value ..................................................................... 296
Section 52.2: optional as return value .................................................................................................................... 296
Section 52.3: value_or .............................................................................................................................................. 297
Section 52.4: Introduction ......................................................................................................................................... 297
Section 52.5: Using optionals to represent the failure of a function ................................................................... 298
Chapter 53: std::function: To wrap any element that is callable .................................................... 300
Section 53.1: Simple usage ....................................................................................................................................... 300
Section 53.2: std::function used with std::bind ........................................................................................................ 300
Section 53.3: Binding std::function to a dierent callable types ........................................................................... 301
Section 53.4: Storing function arguments in std::tuple .......................................................................................... 303
Section 53.5: std::function with lambda and std::bind ............................................................................................ 304
Section 53.6: `function` overhead ............................................................................................................................. 305
Chapter 54: std::forward_list ............................................................................................................................ 306
Section 54.1: Example ................................................................................................................................................ 306
Section 54.2: Methods ............................................................................................................................................... 306
Chapter 55: std::pair ............................................................................................................................................... 308
Section 55.1: Compare operators ............................................................................................................................ 308
Section 55.2: Creating a Pair and accessing the elements ................................................................................... 308
Chapter 56: std::atomics ....................................................................................................................................... 310
Section 56.1: atomic types ........................................................................................................................................ 310
Chapter 57: std::variant ........................................................................................................................................ 312
Section 57.1: Create pseudo-method pointers ....................................................................................................... 312
Section 57.2: Basic std::variant use .......................................................................................................................... 313
Section 57.3: Constructing a `std::variant` ............................................................................................................... 314
Chapter 58: std::iomanip ...................................................................................................................................... 315
Section 58.1: std::setprecision ................................................................................................................................... 315
Section 58.2: std::setfill .............................................................................................................................................. 315
Section 58.3: std::setiosflags ..................................................................................................................................... 315
Section 58.4: std::setw ............................................................................................................................................... 317
Chapter 59: std::any ................................................................................................................................................ 318
Section 59.1: Basic usage .......................................................................................................................................... 318
Chapter 60: std::set and std::multiset ........................................................................................................... 319
Section 60.1: Changing the default sort of a set .................................................................................................... 319
Section 60.2: Deleting values from a set ................................................................................................................ 321
Section 60.3: Inserting values in a set ..................................................................................................................... 322
Section 60.4: Inserting values in a multiset ............................................................................................................ 324
Section 60.5: Searching values in set and multiset ................................................................................................ 324
Chapter 61: std::integer_sequence ................................................................................................................. 326
Section 61.1: Turn a std::tuple<T...> into function parameters ............................................................................... 326
Section 61.2: Create a parameter pack consisting of integers ............................................................................. 327
Section 61.3: Turn a sequence of indices into copies of an element .................................................................... 327
Chapter 62: Using std::unordered_map ....................................................................................................... 329
Section 62.1: Declaration and Usage ....................................................................................................................... 329
Section 62.2: Some Basic Functions ........................................................................................................................ 329
Chapter 63: Standard Library Algorithms ................................................................................................... 330
Section 63.1: std::next_permutation ......................................................................................................................... 330
Section 63.2: std::for_each ....................................................................................................................................... 330
Section 63.3: std::accumulate ................................................................................................................................... 331
Section 63.4: std::find ................................................................................................................................................. 332
Section 63.5: std::min_element ................................................................................................................................ 334
Section 63.6: std::find_if ............................................................................................................................................ 335
Section 63.7: Using std::nth_element To Find The Median (Or Other Quantiles) ............................................... 336
Section 63.8: std::count ............................................................................................................................................. 337
Section 63.9: std::count_if ......................................................................................................................................... 338
Chapter 64: The ISO C++ Standard ................................................................................................................. 340
Section 64.1: Current Working Drafts ...................................................................................................................... 340
Section 64.2: C++17 .................................................................................................................................................... 340
Section 64.3: C++11 ..................................................................................................................................................... 341
Section 64.4: C++14 .................................................................................................................................................... 342
Section 64.5: C++98 ................................................................................................................................................... 343
Section 64.6: C++03 ................................................................................................................................................... 343
Section 64.7: C++20 ................................................................................................................................................... 344
Chapter 65: Random number generation ................................................................................................... 345
Section 65.1: True random value generator ........................................................................................................... 345
Section 65.2: Generating a pseudo-random number ............................................................................................ 345
Section 65.3: Using the generator for multiple distributions ................................................................................ 346
Chapter 66: Date and time using <chrono> header ................................................................................ 347
Section 66.1: Measuring time using <chrono> ........................................................................................................ 347
Section 66.2: Find number of days between two dates ........................................................................................ 347
Chapter 67: Sorting ................................................................................................................................................. 349
Section 67.1: Sorting and sequence containers ...................................................................................................... 349
Section 67.2: sorting with std::map (ascending and descending) ........................................................................ 349
Section 67.3: Sorting sequence containers by overloaded less operator ........................................................... 351
Section 67.4: Sorting sequence containers using compare function ................................................................... 352
Section 67.5: Sorting sequence containers using lambda expressions (C++11) .................................................. 353
Section 67.6: Sorting built-in arrays ........................................................................................................................ 354
Section 67.7: Sorting sequence containers with specifed ordering ..................................................................... 354
Chapter 68: Enumeration ..................................................................................................................................... 355
Section 68.1: Iteration over an enum ....................................................................................................................... 355
Section 68.2: Scoped enums .................................................................................................................................... 356
Section 68.3: Enum forward declaration in C++11 .................................................................................................. 357
Section 68.4: Basic Enumeration Declaration ........................................................................................................ 357
Section 68.5: Enumeration in switch statements ................................................................................................... 358
Chapter 69: Iteration .............................................................................................................................................. 359
Section 69.1: break .................................................................................................................................................... 359
Section 69.2: continue ............................................................................................................................................... 359
Section 69.3: do ......................................................................................................................................................... 359
Section 69.4: while ..................................................................................................................................................... 359
Section 69.5: range-based for loop ......................................................................................................................... 360
Section 69.6: for ......................................................................................................................................................... 360
Chapter 70: Regular expressions ..................................................................................................................... 361
Section 70.1: Basic regex_match and regex_search Examples ........................................................................... 361
Section 70.2: regex_iterator Example ..................................................................................................................... 361
Section 70.3: Anchors ................................................................................................................................................ 362
Section 70.4: regex_replace Example ..................................................................................................................... 363
Section 70.5: regex_token_iterator Example ........................................................................................................ 363
Section 70.6: Quantifiers ........................................................................................................................................... 363
Section 70.7: Splitting a string .................................................................................................................................. 365
Chapter 71: Implementation-defined behavior ......................................................................................... 366
Section 71.1: Size of integral types ........................................................................................................................... 366
Section 71.2: Char might be unsigned or signed .................................................................................................... 368
Section 71.3: Ranges of numeric types ................................................................................................................... 368
Section 71.4: Value representation of floating point types ................................................................................... 369
Section 71.5: Overflow when converting from integer to signed integer ............................................................ 369
Section 71.6: Underlying type (and hence size) of an enum ................................................................................. 370
Section 71.7: Numeric value of a pointer ................................................................................................................. 370
Section 71.8: Number of bits in a byte ..................................................................................................................... 371
Chapter 72: Exceptions .......................................................................................................................................... 372
Section 72.1: Catching exceptions ............................................................................................................................ 372
Section 72.2: Rethrow (propagate) exception ....................................................................................................... 373
Section 72.3: Best practice: throw by value, catch by const reference ............................................................... 374
Section 72.4: Custom exception ............................................................................................................................... 375
Section 72.5: std::uncaught_exceptions .................................................................................................................. 377
Section 72.6: Function Try Block for regular function ........................................................................................... 378
Section 72.7: Nested exception ................................................................................................................................ 378
Section 72.8: Function Try Blocks In constructor ................................................................................................... 380
Section 72.9: Function Try Blocks In destructor ..................................................................................................... 381
Chapter 73: Lambdas ............................................................................................................................................. 382
Section 73.1: What is a lambda expression? ........................................................................................................... 382
Section 73.2: Specifying the return type ................................................................................................................. 384
Section 73.3: Capture by value ................................................................................................................................ 385
Section 73.4: Recursive lambdas ............................................................................................................................. 386
Section 73.5: Default capture ................................................................................................................................... 388
Section 73.6: Class lambdas and capture of this ................................................................................................... 388
Section 73.7: Capture by reference ......................................................................................................................... 390
Section 73.8: Generic lambdas ................................................................................................................................. 390
Section 73.9: Using lambdas for inline parameter pack unpacking .................................................................... 391
Section 73.10: Generalized capture .......................................................................................................................... 393
Section 73.11: Conversion to function pointer ......................................................................................................... 394
Section 73.12: Porting lambda functions to C++03 using functors ....................................................................... 394
Chapter 74: Value Categories ........................................................................................................................... 396
Section 74.1: Value Category Meanings .................................................................................................................. 396
Section 74.2: rvalue ................................................................................................................................................... 396
Section 74.3: xvalue ................................................................................................................................................... 397
Section 74.4: prvalue ................................................................................................................................................. 397
Section 74.5: lvalue .................................................................................................................................................... 398
Section 74.6: glvalue ................................................................................................................................................. 398
Chapter 75: Preprocessor .................................................................................................................................... 399
Section 75.1: Include Guards ..................................................................................................................................... 399
Section 75.2: Conditional logic and cross-platform handling ............................................................................... 400
Section 75.3: X-macros ............................................................................................................................................. 401
Section 75.4: Macros ................................................................................................................................................. 403
Section 75.5: Predefined macros ............................................................................................................................. 406
Section 75.6: Preprocessor Operators .................................................................................................................... 408
Section 75.7: #pragma once .................................................................................................................................... 408
Section 75.8: Preprocessor error messages ........................................................................................................... 409
Chapter 76: Data Structures in C++ ................................................................................................................ 410
Section 76.1: Linked List implementation in C++ ..................................................................................................... 410
Chapter 77: Templates .......................................................................................................................................... 413
Section 77.1: Basic Class Template .......................................................................................................................... 413
Section 77.2: Function Templates ............................................................................................................................ 413
Section 77.3: Variadic template data structures .................................................................................................... 415
Section 77.4: Argument forwarding ........................................................................................................................ 417
Section 77.5: Partial template specialization .......................................................................................................... 418
Section 77.6: Template Specialization ..................................................................................................................... 420
Section 77.7: Alias template ..................................................................................................................................... 420
Section 77.8: Explicit instantiation ............................................................................................................................ 420
Section 77.9: Non-type template parameter ......................................................................................................... 421
Section 77.10: Declaring non-type template arguments with auto ...................................................................... 422
Section 77.11: Template template parameters ....................................................................................................... 423
Section 77.12: Default template parameter value ................................................................................................. 424
Chapter 78: Expression templates ................................................................................................................... 425
Section 78.1: A basic example illustrating expression templates ......................................................................... 425
Chapter 79: Curiously Recurring Template Pattern (CRTP) ............................................................... 429
Section 79.1: The Curiously Recurring Template Pattern (CRTP) ......................................................................... 429
Section 79.2: CRTP to avoid code duplication ........................................................................................................ 430
Chapter 80: Threading ........................................................................................................................................... 432
Section 80.1: Creating a std::thread ......................................................................................................................... 432
Section 80.2: Passing a reference to a thread ....................................................................................................... 434
Section 80.3: Using std::async instead of std::thread ............................................................................................ 434
Section 80.4: Basic Synchronization ........................................................................................................................ 435
Section 80.5: Create a simple thread pool ............................................................................................................. 435
Section 80.6: Ensuring a thread is always joined ................................................................................................... 437
Section 80.7: Operations on the current thread .................................................................................................... 438
Section 80.8: Using Condition Variables ................................................................................................................. 439
Section 80.9: Thread operations ............................................................................................................................. 441
Section 80.10: Thread-local storage ........................................................................................................................ 441
Section 80.11: Reassigning thread objects .............................................................................................................. 441
Chapter 81: Thread synchronization structures ....................................................................................... 443
Section 81.1: std::condition_variable_any, std::cv_status ...................................................................................... 443
Section 81.2: std::shared_lock .................................................................................................................................. 443
Section 81.3: std::call_once, std::once_flag ............................................................................................................. 443
Section 81.4: Object locking for ecient access .................................................................................................... 444
Chapter 82: The Rule of Three, Five, And Zero ......................................................................................... 446
Section 82.1: Rule of Zero ......................................................................................................................................... 446
Section 82.2: Rule of Five ......................................................................................................................................... 447
Section 82.3: Rule of Three ...................................................................................................................................... 448
Section 82.4: Self-assignment Protection ............................................................................................................... 449
Chapter 83: RAII: Resource Acquisition Is Initialization ......................................................................... 451
Section 83.1: Locking ................................................................................................................................................. 451
Section 83.2: ScopeSuccess (c++17) ........................................................................................................................ 452
Section 83.3: ScopeFail (c++17) ................................................................................................................................ 453
Section 83.4: Finally/ScopeExit ................................................................................................................................ 454
Chapter 84: RTTI: Run-Time Type Information ........................................................................................ 455
Section 84.1: dynamic_cast ...................................................................................................................................... 455
Section 84.2: The typeid keyword ........................................................................................................................... 455
Section 84.3: Name of a type ................................................................................................................................... 456
Section 84.4: When to use which cast in c++ .......................................................................................................... 456
Chapter 85: Mutexes ............................................................................................................................................... 457
Section 85.1: Mutex Types ........................................................................................................................................ 457
Section 85.2: std::lock ................................................................................................................................................ 457
Section 85.3: std::unique_lock, std::shared_lock, std::lock_guard ....................................................................... 457
Section 85.4: Strategies for lock classes: std::try_to_lock, std::adopt_lock, std::defer_lock ............................ 458
Section 85.5: std::mutex ............................................................................................................................................ 459
Section 85.6: std::scoped_lock (C++ 17) .................................................................................................................. 459
Chapter 86: Recursive Mutex .............................................................................................................................. 460
Section 86.1: std::recursive_mutex ........................................................................................................................... 460
Chapter 87: Semaphore ........................................................................................................................................ 461
Section 87.1: Semaphore C++ 11 ............................................................................................................................... 461
Section 87.2: Semaphore class in action ................................................................................................................ 461
Chapter 88: Futures and Promises .................................................................................................................. 463
Section 88.1: Async operation classes ..................................................................................................................... 463
Section 88.2: std::future and std::promise ............................................................................................................... 463
Section 88.3: Deferred async example ................................................................................................................... 463
Section 88.4: std::packaged_task and std::future .................................................................................................. 464
Section 88.5: std::future_error and std::future_errc .............................................................................................. 464
Section 88.6: std::future and std::async ................................................................................................................... 465
Chapter 89: Atomic Types .................................................................................................................................... 468
Section 89.1: Multi-threaded Access ........................................................................................................................ 468
Chapter 90: Type Erasure .................................................................................................................................... 470
Section 90.1: A move-only `std::function` ................................................................................................................. 470
Section 90.2: Erasing down to a Regular type with manual vtable ..................................................................... 472
Section 90.3: Basic mechanism ............................................................................................................................... 475
Section 90.4: Erasing down to a contiguous buer of T ....................................................................................... 476
Section 90.5: Type erasing type erasure with std::any ......................................................................................... 477
Chapter 91: Explicit type conversions ............................................................................................................. 482
Section 91.1: C-style casting ...................................................................................................................................... 482
Section 91.2: Casting away constness ..................................................................................................................... 482
Section 91.3: Base to derived conversion ................................................................................................................ 482
Section 91.4: Conversion between pointer and integer ......................................................................................... 483
Section 91.5: Conversion by explicit constructor or explicit conversion function ............................................... 484
Section 91.6: Implicit conversion .............................................................................................................................. 484
Section 91.7: Enum conversions ............................................................................................................................... 484
Section 91.8: Derived to base conversion for pointers to members .................................................................... 486
Section 91.9: void* to T* ............................................................................................................................................. 486
Section 91.10: Type punning conversion ................................................................................................................. 487
Chapter 92: Unnamed types ............................................................................................................................... 488
Section 92.1: Unnamed classes ................................................................................................................................ 488
Section 92.2: As a type alias .................................................................................................................................... 488
Section 92.3: Anonymous members ....................................................................................................................... 488
Section 92.4: Anonymous Union .............................................................................................................................. 489
Chapter 93: Type Traits ......................................................................................................................................... 490
Section 93.1: Type Properties ................................................................................................................................... 490
Section 93.2: Standard type traits ........................................................................................................................... 491
Section 93.3: Type relations with std::is_same<T, T> ............................................................................................ 492
Section 93.4: Fundamental type traits .................................................................................................................... 493
Chapter 94: Return Type Covariance ............................................................................................................ 494
Section 94.1: Covariant result version of the base example, static type checking ............................................. 494
Section 94.2: Covariant smart pointer result (automated cleanup) .................................................................... 494
Chapter 95: Layout of object types ................................................................................................................ 496
Section 95.1: Class types ........................................................................................................................................... 496
Section 95.2: Arithmetic types ................................................................................................................................. 498
Section 95.3: Arrays .................................................................................................................................................. 499
Chapter 96: Type Inference ................................................................................................................................ 500
Section 96.1: Data Type: Auto .................................................................................................................................. 500
Section 96.2: Lambda auto ...................................................................................................................................... 500
Section 96.3: Loops and auto ................................................................................................................................... 500
Chapter 97: Typedef and type aliases .......................................................................................................... 502
Section 97.1: Basic typedef syntax .......................................................................................................................... 502
Section 97.2: More complex uses of typedef ......................................................................................................... 502
Section 97.3: Declaring multiple types with typedef ............................................................................................. 503
Section 97.4: Alias declaration with "using" ............................................................................................................ 503
Chapter 98: type deduction ................................................................................................................................ 504
Section 98.1: Template parameter deduction for constructors ........................................................................... 504
Section 98.2: Auto Type Deduction ......................................................................................................................... 504
Section 98.3: Template Type Deduction ................................................................................................................. 505
Chapter 99: Trailing return type ....................................................................................................................... 507
Section 99.1: Avoid qualifying a nested type name ............................................................................................... 507
Section 99.2: Lambda expressions .......................................................................................................................... 507
Chapter 100: Alignment ......................................................................................................................................... 508
Section 100.1: Controlling alignment ........................................................................................................................ 508
Section 100.2: Querying the alignment of a type .................................................................................................. 508
Chapter 101: Perfect Forwarding ...................................................................................................................... 510
Section 101.1: Factory functions ................................................................................................................................ 510
Chapter 102: decltype ............................................................................................................................................ 511
Section 102.1: Basic Example .................................................................................................................................... 511
Section 102.2: Another example ............................................................................................................................... 511
Chapter 103: SFINAE (Substitution Failure Is Not An Error) ................................................................ 512
Section 103.1: What is SFINAE ................................................................................................................................... 512
Section 103.2: void_t ................................................................................................................................................. 512
Section 103.3: enable_if ............................................................................................................................................ 514
Section 103.4: is_detected ........................................................................................................................................ 515
Section 103.5: Overload resolution with a large number of options .................................................................... 517
Section 103.6: trailing decltype in function templates ........................................................................................... 518
Section 103.7: enable_if_all / enable_if_any ........................................................................................................ 519
Chapter 104: Undefined Behavior .................................................................................................................... 521
Section 104.1: Reading or writing through a null pointer ....................................................................................... 521
Section 104.2: Using an uninitialized local variable ............................................................................................... 521
Section 104.3: Accessing an out-of-bounds index .................................................................................................. 522
Section 104.4: Deleting a derived object via a pointer to a base class that doesn't have a virtual destructor
............................................................................................................................................................................. 522
Section 104.5: Extending the `std` or `posix` Namespace ...................................................................................... 522
Section 104.6: Invalid pointer arithmetic ................................................................................................................. 523
Section 104.7: No return statement for a function with a non-void return type ................................................. 524
Section 104.8: Accessing a dangling reference ...................................................................................................... 524
Section 104.9: Integer division by zero .................................................................................................................... 525
Section 104.10: Shifting by an invalid number of positions ................................................................................... 525
Section 104.11: Incorrect pairing of memory allocation and deallocation ........................................................... 525
Section 104.12: Signed Integer Overflow ................................................................................................................. 526
Section 104.13: Multiple non-identical definitions (the One Definition Rule) ........................................................ 526
Section 104.14: Modifying a const object ................................................................................................................ 527
Section 104.15: Returning from a [[noreturn]] function ........................................................................................ 528
Section 104.16: Infinite template recursion .............................................................................................................. 528
Section 104.17: Overflow during conversion to or from floating point type ........................................................ 529
Section 104.18: Modifying a string literal ................................................................................................................. 529
Section 104.19: Accessing an object as the wrong type ........................................................................................ 529
Section 104.20: Invalid derived-to-base conversion for pointers to members ................................................... 530
Section 104.21: Destroying an object that has already been destroyed ............................................................. 530
Section 104.22: Access to nonexistent member through pointer to member ..................................................... 531
Section 104.23: Invalid base-to-derived static cast ................................................................................................ 531
Section 104.24: Floating point overflow .................................................................................................................. 531
Section 104.25: Calling (Pure) Virtual Members From Constructor Or Destructor ............................................. 531
Section 104.26: Function call through mismatched function pointer type .......................................................... 532
Chapter 105: Overload resolution .................................................................................................................... 533
Section 105.1: Categorization of argument to parameter cost ............................................................................. 533
Section 105.2: Arithmetic promotions and conversions ........................................................................................ 533
Section 105.3: Overloading on Forwarding Reference .......................................................................................... 534
Section 105.4: Exact match ....................................................................................................................................... 535
Section 105.5: Overloading on constness and volatility ........................................................................................ 535
Section 105.6: Name lookup and access checking ................................................................................................ 536
Section 105.7: Overloading within a class hierarchy .............................................................................................. 537
Section 105.8: Steps of Overload Resolution .......................................................................................................... 538
Chapter 106: Move Semantics ............................................................................................................................ 540
Section 106.1: Move semantics ................................................................................................................................. 540
Section 106.2: Using std::move to reduce complexity from O(n²) to O(n) ........................................................... 540
Section 106.3: Move constructor .............................................................................................................................. 543
Section 106.4: Re-use a moved object .................................................................................................................... 545
Section 106.5: Move assignment .............................................................................................................................. 545
Section 106.6: Using move semantics on containers ............................................................................................. 546
Chapter 107: Pimpl Idiom ...................................................................................................................................... 547
Section 107.1: Basic Pimpl idiom ............................................................................................................................... 547
Chapter 108: auto ..................................................................................................................................................... 549
Section 108.1: Basic auto sample ............................................................................................................................. 549
Section 108.2: Generic lambda (C++14) ................................................................................................................... 549
Section 108.3: auto and proxy objects .................................................................................................................... 550
Section 108.4: auto and Expression Templates ...................................................................................................... 550
Section 108.5: auto, const, and references ............................................................................................................. 551
Section 108.6: Trailing return type ........................................................................................................................... 551
Chapter 109: Copy Elision ..................................................................................................................................... 553
Section 109.1: Purpose of copy elision ..................................................................................................................... 553
Section 109.2: Guaranteed copy elision .................................................................................................................. 554
Section 109.3: Parameter elision .............................................................................................................................. 555
Section 109.4: Return value elision .......................................................................................................................... 555
Section 109.5: Named return value elision .............................................................................................................. 555
Section 109.6: Copy initialization elision .................................................................................................................. 556
Chapter 110: Fold Expressions ............................................................................................................................ 557
Section 110.1: Unary Folds ......................................................................................................................................... 557
Section 110.2: Binary Folds ....................................................................................................................................... 557
Section 110.3: Folding over a comma ...................................................................................................................... 558
Chapter 111: Unions ................................................................................................................................................... 559
Section 111.1: Undefined Behavior ............................................................................................................................. 559
Section 111.2: Basic Union Features ......................................................................................................................... 559
Section 111.3: Typical Use .......................................................................................................................................... 559
Chapter 112: Design pattern implementation in C++ .............................................................................. 561
Section 112.1: Adapter Pattern .................................................................................................................................. 561
Section 112.2: Observer pattern ............................................................................................................................... 563
Section 112.3: Factory Pattern .................................................................................................................................. 566
Section 112.4: Builder Pattern with Fluent API ......................................................................................................... 566
Chapter 113: Singleton Design Pattern .......................................................................................................... 570
Section 113.1: Lazy Initialization ................................................................................................................................ 570
Section 113.2: Static deinitialization-safe singleton ................................................................................................ 571
Section 113.3: Thread-safe Singeton ........................................................................................................................ 571
Section 113.4: Subclasses .......................................................................................................................................... 571
Chapter 114: User-Defined Literals .................................................................................................................. 573
Section 114.1: Self-made user-defined literal for binary ........................................................................................ 573
Section 114.2: Standard user-defined literals for duration .................................................................................... 573
Section 114.3: User-defined literals with long double values ................................................................................. 574
Section 114.4: Standard user-defined literals for strings ....................................................................................... 574
Section 114.5: Standard user-defined literals for complex .................................................................................... 575
Chapter 115: Memory management ................................................................................................................ 576
Section 115.1: Free Storage (Heap, Dynamic Allocation ...) .................................................................................... 576
Section 115.2: Placement new ................................................................................................................................... 577
Section 115.3: Stack .................................................................................................................................................... 578
Chapter 116: C++11 Memory Model .................................................................................................................... 579
Section 116.1: Need for Memory Model .................................................................................................................... 579
Section 116.2: Fence example ................................................................................................................................... 580
Chapter 117: Scopes ................................................................................................................................................. 582
Section 117.1: Global variables .................................................................................................................................. 582
Section 117.2: Simple block scope ............................................................................................................................ 582
Chapter 118: static_assert ................................................................................................................................... 584
Section 118.1: static_assert ........................................................................................................................................ 584
Chapter 119: constexpr ........................................................................................................................................... 585
Section 119.1: constexpr variables ............................................................................................................................ 585
Section 119.2: Static if statement .............................................................................................................................. 586
Section 119.3: constexpr functions ............................................................................................................................ 587
Chapter 120: One Definition Rule (ODR) ....................................................................................................... 589
Section 120.1: ODR violation via overload resolution ............................................................................................. 589
Section 120.2: Multiply defined function .................................................................................................................. 589
Section 120.3: Inline functions .................................................................................................................................. 590
Chapter 121: Unspecified behavior ................................................................................................................... 592
Section 121.1: Value of an out-of-range enum ........................................................................................................ 592
Section 121.2: Evaluation order of function arguments ......................................................................................... 592
Section 121.3: Result of some reinterpret_cast conversions ................................................................................. 593
Section 121.4: Space occupied by a reference ....................................................................................................... 594
Section 121.5: Moved-from state of most standard library classes ..................................................................... 594
Section 121.6: Result of some pointer comparisons ............................................................................................... 595
Section 121.7: Static cast from bogus void* value .................................................................................................. 595
Section 121.8: Order of initialization of globals across TU .................................................................................... 595
Chapter 122: Argument Dependent Name Lookup ................................................................................. 597
Section 122.1: What functions are found ................................................................................................................. 597
Chapter 123: Attributes .......................................................................................................................................... 598
Section 123.1: [[fallthrough]] .................................................................................................................................... 598
Section 123.2: [[nodiscard]] ..................................................................................................................................... 598
Section 123.3: [[deprecated]] and [[deprecated("reason")]] .............................................................................. 599
Section 123.4: [[maybe_unused]] ........................................................................................................................... 599
Section 123.5: [[noreturn]] ........................................................................................................................................ 600
Chapter 124: Recursion in C++ ........................................................................................................................... 602
Section 124.1: Using tail recursion and Fibonnaci-style recursion to solve the Fibonnaci sequence ................ 602
Section 124.2: Recursion with memoization ............................................................................................................ 602
Chapter 125: Arithmitic Metaprogramming ................................................................................................ 604
Section 125.1: Calculating power in O(log n) ........................................................................................................... 604
Chapter 126: Callable Objects ............................................................................................................................ 606
Section 126.1: Function Pointers ............................................................................................................................... 606
Section 126.2: Classes with operator() (Functors) ................................................................................................. 606
Chapter 127: Client server examples .............................................................................................................. 608
Section 127.1: Hello TCP Client .................................................................................................................................. 608
Section 127.2: Hello TCP Server ............................................................................................................................... 609
Chapter 128: Const Correctness ........................................................................................................................ 613
Section 128.1: The Basics ........................................................................................................................................... 613
Section 128.2: Const Correct Class Design ............................................................................................................. 613
Section 128.3: Const Correct Function Parameters ............................................................................................... 615
Section 128.4: Const Correctness as Documentation ............................................................................................ 617
Chapter 129: Parameter packs .......................................................................................................................... 621
Section 129.1: A template with a parameter pack .................................................................................................. 621
Section 129.2: Expansion of a parameter pack ...................................................................................................... 621
Chapter 130: Build Systems ................................................................................................................................. 622
Section 130.1: Generating Build Environment with CMake .................................................................................... 622
Section 130.2: Compiling with GNU make ............................................................................................................... 623
Section 130.3: Building with SCons ........................................................................................................................... 625
Section 130.4: Autotools (GNU) ................................................................................................................................ 625
Section 130.5: Ninja .................................................................................................................................................... 626
Section 130.6: NMAKE (Microsoft Program Maintenance Utility) ......................................................................... 626
Chapter 131: Concurrency With OpenMP ....................................................................................................... 627
Section 131.1: OpenMP: Parallel Sections ................................................................................................................. 627
Section 131.2: OpenMP: Parallel Sections ................................................................................................................. 627
Section 131.3: OpenMP: Parallel For Loop ................................................................................................................ 628
Section 131.4: OpenMP: Parallel Gathering / Reduction ........................................................................................ 628
Chapter 132: Resource Management .............................................................................................................. 630
Section 132.1: Resource Acquisition Is Initialization ................................................................................................ 630
Section 132.2: Mutexes & Thread Safety ................................................................................................................. 631
Chapter 133: Storage class specifiers ............................................................................................................ 633
Section 133.1: extern ................................................................................................................................................... 633
Section 133.2: register ............................................................................................................................................... 634
Section 133.3: static ................................................................................................................................................... 634
Section 133.4: auto ..................................................................................................................................................... 635
Section 133.5: mutable .............................................................................................................................................. 635
Chapter 134: Linkage specifications ............................................................................................................... 637
Section 134.1: Signal handler for Unix-like operating system ............................................................................... 637
Section 134.2: Making a C library header compatible with C++ ........................................................................... 637
Chapter 135: Digit separators ............................................................................................................................ 639
Section 135.1: Digit Separator ................................................................................................................................... 639
Chapter 136: C incompatibilities ........................................................................................................................ 640
Section 136.1: Reserved Keywords ........................................................................................................................... 640
Section 136.2: Weakly typed pointers ..................................................................................................................... 640
Section 136.3: goto or switch .................................................................................................................................... 640
Chapter 137: Side by Side Comparisons of classic C++ examples solved via C++ vs C++11
vs C++14 vs C++17 ..................................................................................................................................................... 641
Section 137.1: Looping through a container ............................................................................................................ 641
Chapter 138: Compiling and Building .............................................................................................................. 642
Section 138.1: Compiling with GCC ........................................................................................................................... 642
Section 138.2: Compiling with Visual Studio (Graphical Interface) - Hello World ............................................... 643
Section 138.3: Online Compilers ............................................................................................................................... 648
Section 138.4: Compiling with Visual C++ (Command Line) .................................................................................. 650
Section 138.5: Compiling with Clang ........................................................................................................................ 653
Section 138.6: The C++ compilation process ........................................................................................................... 653
Section 138.7: Compiling with Code::Blocks (Graphical interface) ........................................................................ 655
Chapter 139: Common compile/linker errors (GCC) ............................................................................... 658
Section 139.1: undefined reference to `***' ................................................................................................................ 658
Section 139.2: error: '***' was not declared in this scope ........................................................................................ 658
Section 139.3: fatal error: ***: No such file or directory ........................................................................................... 660
Chapter 140: More undefined behaviors in C++ ........................................................................................ 661
Section 140.1: Referring to non-static members in initializer lists ......................................................................... 661
Chapter 141: Unit Testing in C++ ....................................................................................................................... 662
Section 141.1: Google Test ......................................................................................................................................... 662
Section 141.2: Catch ................................................................................................................................................... 662
Chapter 142: C++ Debugging and Debug-prevention Tools & Techniques ................................. 664
Section 142.1: Static analysis .................................................................................................................................... 664
Section 142.2: Segfault analysis with GDB .............................................................................................................. 665
Section 142.3: Clean code ......................................................................................................................................... 666
Chapter 143: Optimization in C++ ..................................................................................................................... 668
Section 143.1: Introduction to performance ............................................................................................................ 668
Section 143.2: Empty Base Class Optimization ...................................................................................................... 668
Section 143.3: Optimizing by executing less code .................................................................................................. 669
Section 143.4: Using ecient containers ................................................................................................................. 670
Section 143.5: Small Object Optimization ................................................................................................................ 671
Chapter 144: Optimization .................................................................................................................................. 673
Section 144.1: Inline Expansion/Inlining ................................................................................................................... 673
Section 144.2: Empty base optimization ................................................................................................................. 673
Chapter 145: Profiling ............................................................................................................................................. 675
Section 145.1: Profiling with gcc and gprof ............................................................................................................. 675
Section 145.2: Generating callgraph diagrams with gperf2dot ............................................................................ 675
Section 145.3: Profiling CPU Usage with gcc and Google Perf Tools ................................................................... 676
Chapter 146: Refactoring Techniques ........................................................................................................... 678
Section 146.1: Goto Cleanup ...................................................................................................................................... 678
Credits ............................................................................................................................................................................ 679
You may also like ...................................................................................................................................................... 686
About
Please feel free to share this PDF with anyone for free,
latest version of this book can be downloaded from:
http://GoalKicker.com/CPlusPlusBook
This C++ Notes for Professionals book is compiled from Stack Overflow
Documentation, the content is written by the beautiful people at Stack Overflow.
Text content is released under Creative Commons BY-SA, see credits at the end
of this book whom contributed to the various chapters. Images may be copyright
of their respective owners unless otherwise specified
This is an unofficial free book created for educational purposes and is not
affiliated with official C++ group(s) or company(s) nor Stack Overflow. All
trademarks and registered trademarks are the property of their respective
company owners
#include <iostream>
int main()
{
std::cout << "Hello World!" << std::endl;
}
Analysis
#include <iostream> is a preprocessor directive that includes the content of the standard C++ header file
iostream.
iostream is a standard library header file that contains definitions of the standard input and output
streams. These definitions are included in the std namespace, explained below.
The standard input/output (I/O) streams provide ways for programs to get input from and output to an
external system -- usually the terminal.
int main() { ... } defines a new function named main. By convention, the main function is called upon
execution of the program. There must be only one main function in a C++ program, and it must always return
a number of the int type.
Here, the int is what is called the function's return type. The value returned by the main function is an exit
code.
By convention, a program exit code of 0 or EXIT_SUCCESS is interpreted as success by a system that executes
the program. Any other return code is associated with an error.
If no return statement is present, the main function (and thus, the program itself) returns 0 by default. In this
example, we don't need to explicitly write return 0;.
All other functions, except those that return the void type, must explicitly return a value according to their
return type, or else must not return at all.
std is a namespace, and :: is the scope resolution operator that allows look-ups for objects by name
within a namespace.
There are many namespaces. Here, we use :: to show we want to use cout from the std namespace.
For more information refer to Scope Resolution Operator - Microsoft Documentation.
std::cout is the standard output stream object, defined in iostream, and it prints to the standard
output (stdout).
<< is, in this context, the stream insertion operator, so called because it inserts an object into the
stream object.
The standard library defines the << operator to perform data insertion for certain data types into
output streams. stream << content inserts content into the stream and returns the same, but
updated stream. This allows stream insertions to be chained: std::cout << "Foo" << " Bar"; prints
"FooBar" to the console.
"Hello World!" is a character string literal, or a "text literal." The stream insertion operator for
character string literals is defined in file iostream.
std::endl is a special I/O stream manipulator object, also defined in file iostream. Inserting a
manipulator into a stream changes the state of the stream.
The stream manipulator std::endl does two things: first it inserts the end-of-line character and then it
flushes the stream buffer to force the text to show up on the console. This ensures that the data
inserted into the stream actually appear on your console. (Stream data is usually stored in a buffer and
then "flushed" in batches unless you force a flush immediately.)
The semicolon (;) notifies the compiler that a statement has ended. All C++ statements and class
definitions require an ending/terminating semicolon.
Single-Line Comments
The double forward-slash sequence // will mark all text until a newline as a comment:
int main()
{
C-Style/Block Comments
The sequence /* is used to declare the start of the comment block and the sequence */ is used to declare the end
of comment. All text between the start and end sequences is interpreted as a comment, even if the text is
otherwise valid C++ syntax. These are sometimes called "C-style" comments, as this comment syntax is inherited
from C++'s predecessor language, C:
int main()
{
/*
* This is a block comment.
*/
int a;
}
In any block comment, you can write anything you want. When the compiler encounters the symbol */, it
terminates the block comment:
int main()
{
/* A block comment with the symbol /*
Note that the compiler is not affected by the second /*
however, once the end-block-comment symbol is reached,
the comment ends.
*/
int a;
}
The above example is valid C++ (and C) code. However, having additional /* inside a block comment might result in
a warning on some compilers.
Block comments can also start and end within a single line. For example:
Importance of Comments
The need for comments can be reduced by writing clear, self-documenting code. A simple example is the use of
explanatory names for variables, functions, and types. Factoring out logically related tasks into discrete functions
goes hand-in-hand with this.
During development, comments can also be used to quickly disable portions of code without deleting it. This is
often useful for testing or debugging purposes, but is not good style for anything other than temporary edits. This
is often referred to as “commenting out”.
Similarly, keeping old versions of a piece of code in a comment for reference purposes is frowned upon, as it
clutters files while offering little value compared to exploring the code's history via a versioning system.
A compiler is a program that translates code from a programming language into another form which is (more)
directly executable for a computer. Using a compiler to translate code is called compilation.
C++ inherits the form of its compilation process from its "parent" language, C. Below is a list showing the four major
steps of compilation in C++:
1. The C++ preprocessor copies the contents of any included header files into the source code file, generates
macro code, and replaces symbolic constants defined using #define with their values.
2. The expanded source code file produced by the C++ preprocessor is compiled into assembly language
appropriate for the platform.
3. The assembler code generated by the compiler is assembled into appropriate object code for the platform.
4. The object code file generated by the assembler is linked together with the object code files for any library
functions used to produce an executable file.
Note: some compiled code is linked together, but not to create a final program. Usually, this "linked" code
can also be packaged into a format that can be used by other programs. This "bundle of packaged, usable
code" is what C++ programmers refer to as a library.
Many C++ compilers may also merge or un-merge certain parts of the compilation process for ease or for additional
analysis. Many C++ programmers will use different tools, but all of the tools will generally follow this generalized
process when they are involved in the production of a program.
The link below extends this discussion and provides a nice graphic to help. [1]:
http://faculty.cs.niu.edu/~mcmahon/CS241/Notes/compile.html
Functions can accept arguments or values and return a single value (or not). To use a function, a function call is
used on argument values and the use of the function call itself is replaced with its return value.
Every function has a type signature -- the types of its arguments and the type of its return type.
Functions are inspired by the concepts of the procedure and the mathematical function.
Note: C++ functions are essentially procedures and do not follow the exact definition or rules of
mathematical functions.
Functions are often meant to perform a specific task. and can be called from other parts of a program. A function
must be declared and defined before it is called elsewhere in a program.
Function Declaration
A function declaration is declares the existence of a function with its name and type signature to the compiler.
The syntax is as the following:
int add2(int i); // The function is of the type (int) -> (int)
In the example above, the int add2(int i) function declares the following to the compiler:
The argument name is optional; the declaration for the function could also be the following:
Per the one-definition rule, a function with a certain type signature can only be declared or defined once in an
entire C++ code base visible to the C++ compiler. In other words, functions with a specific type signature cannot be
re-defined -- they must only be defined once. Thus, the following is not valid C++:
int add2(int i); // The compiler will note that add2 is a function (int) -> int
int add2(int j); // As add2 already has a definition of (int) -> int, the compiler
// will regard this as an error.
If a function returns nothing, its return type is written as void. If it takes no parameters, the parameter list should
be empty.
void do_something(); // The function takes no parameters, and does not return anything.
// Note that it can still affect variables it has access to.
Function Call
A function can be called after it has been declared. For example, the following program calls add2 with the value of
2 within the function of main:
#include <iostream>
int main()
{
std::cout << add2(2) << "\n"; // add2(2) will be evaluated at this point,
// and the result is printed.
return 0;
}
A function definition* is similar to a declaration, except it also contains the code that is executed when the function
is called within its body.
int add2(int i) // Data that is passed into (int i) will be referred to by the name i
{ // while in the function's curly brackets or "scope."
Function Overloading
You can create multiple functions with the same name but different parameters.
int add2(int i, int j) // However, when add2() is called with two parameters, the
{ // code from the initial declaration will be overloaded,
int k = i + j + 2 ; // and the code in this declaration will be evaluated
return k; // instead.
}
Both functions are called by the same name add2, but the actual function that is called depends directly on the
amount and type of the parameters in the call. In most cases, the C++ compiler can compute which function to call.
In some cases, the type must be explicitly stated.
Default Parameters
Default values for function parameters can only be specified in function declarations.
In this example, multiply() can be called with one or two parameters. If only one parameter is given, b will have
default value of 7. Default arguments must be placed in the latter arguments of the function. For example:
There exist special function calls in C++ which have different syntax than name_of_function(value1, value2,
value3). The most common example is that of operators.
Certain special character sequences that will be reduced to function calls by the compiler, such as !, +, -, *, %, and
<< and many more. These special characters are normally associated with non-programming usage or are used for
C++ handles these character sequences with a special syntax; but, in essence, each occurrence of an operator is
reduced to a function call. For example, the following C++ expression:
3+3
operator+(3, 3)
While in C++'s immediate predecessor, C, operator function names cannot be assigned different meanings by
providing additional definitions with different type signatures, in C++, this is valid. "Hiding" additional function
definitions under one unique function name is referred to as operator overloading in C++, and is a relatively
common, but not universal, convention in C++.
int main()
{
foo(2); // error: foo is called, but has not yet been declared
}
There are two ways to resolve this: putting either the definition or declaration of foo() before its usage in main().
Here is one example:
int main()
{
foo(2); // OK: foo is completely defined beforehand, so it can be called here.
}
However it is also possible to "forward-declare" the function by putting only a "prototype" declaration before its
usage and then defining the function body later:
One common way to integrate this into the organization of source files is to make a header file containing all of the
prototype declarations:
// foo.h
void foo(int); // prototype declaration
and then, once compiled, link the corresponding object file foo.o into the compiled object file where it is used in
the linking phase, main.o:
An “unresolved external symbol” error occurs when the function prototype and call exist, but the function body is
not defined. These can be trickier to resolve as the compiler won't report the error until the final linking stage, and
it doesn't know which line to jump to in the code to show the error.
It edits the source code, cutting some bits out, changing others, and adding other things.
In source files, we can include preprocessor directives. These directives tells the preprocessor to perform specific
actions. A directive starts with a # on a new line. Example:
#define ZERO 0
#include <something>
directive. What it does is takes all of something and inserts it in your file where the directive was. The hello world
program starts with the line
#include <iostream>
This line adds the functions and objects that let you use the standard input and output.
The C language, which also uses the preprocessor, does not have as many header files as the C++ language, but in
C++ you can use all the C header files.
directive. This tells the preprocessor that as it goes along the file, it should replace every occurrence of something
with something_else. It can also make things similar to functions, but that probably counts as advanced C++.
The something_else is not needed, but if you define something as nothing, then outside preprocessor directives, all
occurrences of something will vanish.
This actually is useful, because of the #if,#else and #ifdef directives. The format for these would be the following:
#if something==true
//code
#else
//more code
#endif
#ifdef thing_that_you_want_to_know_if_is_defined
//code
#endif
These directives insert the code that is in the true bit, and deletes the false bits. this can be used to have bits of
code that are only included on certain operating systems, without having to rewrite the whole code.
However, C++11 also added user-defined literals, which are not literals in the traditional sense but can be used as a
shorthand for function calls.
struct S {
int x;
S& operator=(const S& other) {
x = other.x;
// return a reference to the object being assigned to
return *this;
}
};
The type of this depends on the cv-qualification of the member function: if X::f is const, then the type of this
within f is const X*, so this cannot be used to modify non-static data members from within a const member
function. Likewise, this inherits volatile qualification from the function it appears in.
Version ≥ C++11
struct S;
struct T {
T(const S* s);
// ...
};
struct S {
// ...
T t{this};
};
decimal-literal
It is a non-zero decimal digit (1, 2, 3, 4, 5, 6, 7, 8, 9), followed by zero or more decimal digits (0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
int d = 42;
octal-literal
It is the digit zero (0) followed by zero or more octal digits (0, 1, 2, 3, 4, 5, 6, 7)
hex-literal
It is the character sequence 0x or the character sequence 0X followed by one or more hexadecimal digits (0, 1, 2, 3,
4, 5, 6, 7, 8, 9, a, A, b, B, c, C, d, D, e, E, f, F)
It is the character sequence 0b or the character sequence 0B followed by one or more binary digits (0, 1)
Integer-suffix, if provided, may contain one or both of the following (if both are provided, they may appear in any
order:
long-suffix (the character l or the character L) or the long-long-suffix (the character sequence ll or the
character sequence LL) (since C++11)
Notes
Letters in the integer literals are case-insensitive: 0xDeAdBaBeU and 0XdeadBABEu represent the same number
(one exception is the long-long-suffix, which is either ll or LL, never lL or Ll)
There are no negative integer literals. Expressions such as -1 apply the unary minus operator to the value
represented by the literal, which may involve implicit type conversions.
In C prior to C99 (but not in C++), unsuffixed decimal values that do not fit in long int are allowed to have the type
unsigned long int.
When used in a controlling expression of #if or #elif, all signed integer constants act as if they have type
std::intmax_t and all unsigned integer constants act as if they have type std::uintmax_t.
bool ok = true;
if (!f()) {
ok = false;
goto end;
}
bool ok = true;
if (!f()) {
ok = false;
goto end;
}
A keyword denoting a null pointer constant. It can be converted to any pointer or pointer-to-member type, yielding
a null pointer of the resulting type.
Note that nullptr is not itself a pointer. The type of nullptr is a fundamental type known as std::nullptr_t.
int main() {
f(nullptr); // ok
g(nullptr); // error
h(nullptr); // ok
}
class MyString {
public:
MyString() { /* ... */ }
// ...
static constexpr int max_size = INT_MAX / 2;
};
// in C++14, this definition was required in a single translation unit:
// constexpr int MyString::max_size;
#include <iostream>
#include <string>
int main(){
bool result;
//let's evaluate 3 booleans with || and && to illustrate operator precedence
//precedence does not mean that && will be evaluated first but rather where
//parentheses would be added
//example 1
result =
False("A") || False("B") && False("C");
// eq. False("A") || (False("B") && False("C"))
//FalseA
//FalseB
//"Short-circuit evaluation skip of C"
//A is false so we have to evaluate the right of ||,
//B being false we do not have to evaluate C to know that the result is false
result =
True("A") || False("B") && False("C");
// eq. True("A") || (False("B") && False("C"))
cout << result << " :=====================" << endl;
//TrueA
//"Short-circuit evaluation skip of B"
//"Short-circuit evaluation skip of C"
//A is true so we do not have to evaluate
// the right of || to know that the result is true
//If || had precedence over && the equivalent evaluation would be:
// (True("A") || False("B")) && False("C")
//What would print
//TrueA
//"Short-circuit evaluation skip of B"
//FalseC
//Because the parentheses are placed differently
//the parts that get evaluated are differently
//which makes that the end result in this case would be False because C is false
When used postfix, the action occurs only after the entire operation is evaluated, leading to some interesting
arithmetics:
int a = 1;
++a; // result: 2
a--; // result: 1
int minusa=-a; // result: -1
bool b = true;
!b; // result: true
a=4;
int c = a++/2; // equal to: (a==4) 4 / 2 result: 2 ('a' incremented postfix)
cout << a << endl; // prints 5!
int d = ++a/2; // equal to: (a+1) == 6 / 2 result: 3
Multiplication and division have left associativity(meaning that they will be evaluated from left to right) and they
have higher precedence than addition and subtraction, which also have left associativity.
We can also force the precedence of expression using parentheses ( ). Just the same way as you would do that in
normal mathematics.
//Addition:
//With Multiplication
Adding the parenthesis does not change the behavior, though, it does make it easier to read. By adding these
parentheses, no confusion exist about the intent of the writer.
float total = 0;
for(float a = 0; a != 2; a += 0.01f) {
total += a;
}
The novice programmer assumes that this will sum up every single number in the range 0, 0.01, 0.02, 0.03,
..., 1.97, 1.98, 1.99, to yield the result 199—the mathematically correct answer.
1. The program as written never concludes. a never becomes equal to 2, and the loop never terminates.
2. If we rewrite the loop logic to check a < 2 instead, the loop terminates, but the total ends up being
something different from 199. On IEEE754-compliant machines, it will often sum up to about 201 instead.
The reason that this happens is that Floating Point Numbers represent Approximations of their assigned
values.
double a = 0.1;
double b = 0.2;
double c = 0.3;
if(a + b == c)
//This never prints on IEEE754-compliant machines
std::cout << "This Computer is Magic!" << std::endl;
else
std::cout << "This Computer is pretty normal, all things considered." << std::endl;
Though what we the programmer see is three numbers written in base10, what the compiler (and the underlying
hardware) see are binary numbers. Because 0.1, 0.2, and 0.3 require perfect division by 10—which is quite easy in
a base-10 system, but impossible in a base-2 system—these numbers have to be stored in imprecise formats,
similar to how the number 1/3 has to be stored in the imprecise form 0.333333333333333... in base-10.
std::cout << "a = " << a << ", b = " << b << ", c = " << c << std::endl;
Output
a = 5, b = 12, c = 13
Why
A bit wise OR operates on the bit level and uses the following Boolean truth table:
When the binary value for a (0101) and the binary value for b (1100) are OR'ed together we get the binary value of
1101:
int a = 0 1 0 1
int b = 1 1 0 0 |
---------
int c = 1 1 0 1
The bit wise OR does not change the value of the original values unless specifically assigned to using the bit wise
assignment compound operator |=:
std::cout << "a = " << a << ", b = " << b << ", c = " << c << std::endl;
Output
a = 5, b = 9, c = 12
Why
A bit wise XOR (exclusive or) operates on the bit level and uses the following Boolean truth table:
Using this, when the binary value for a (0101) and the binary value for b (1001) are XOR'ed together we get the binary
value of 1100:
int a = 0 1 0 1
int b = 1 0 0 1 ^
---------
int c = 1 1 0 0
The bit wise XOR does not change the value of the original values unless specifically assigned to using the bit wise
assignment compound operator ^=:
The bit wise XOR can be utilized in many ways and is often utilized in bit mask operations for encryption and
compression.
Note: The following example is often shown as an example of a nice trick. But should not be used in production
code (there are better ways std::swap() to achieve the same result).
You can also utilize an XOR operation to swap two variables without a temporary:
int a = 42;
int b = 64;
// XOR swap
a ^= b;
b ^= a;
a ^= b;
std::cout << "a = " << a << ", b = " << b << "\n";
To productionalize this you need to add a check to make sure it can be used.
So though it looks like a nice trick in isolation it is not useful in real code. xor is not a base logical operation,but a
combination of others: a^c=~(a&c)&(a|c)
int cn=0b0111;
std::cout << "a = " << a << ", b = " << b << ", c = " << c << std::endl;
Output
a = 6, b = 10, c = 2
Why
A bit wise AND operates on the bit level and uses the following Boolean truth table:
When the binary value for a (0110) and the binary value for b (1010) are AND'ed together we get the binary value of
0010:
int a = 0 1 1 0
int b = 1 0 1 0 &
---------
int c = 0 0 1 0
The bit wise AND does not change the value of the original values unless specifically assigned to using the bit wise
assignment compound operator &=:
std::cout << "a = " << a << ", b = " << b << std::endl;
Output
a = 1, b = 2
Why
The left bit wise shift will shift the bits of the left hand value (a) the number specified on the right (1), essentially
padding the least significant bits with 0's, so shifting the value of 5 (binary 0000 0101) to the left 4 times (e.g. 5 <<
4) will yield the value of 80 (binary 0101 0000). You might note that shifting a value to the left 1 time is also the same
as multiplying the value by 2, example:
int a = 7;
while (a < 200) {
std::cout << "a = " << a << std::endl;
a <<= 1;
a = 7;
while (a < 200) {
std::cout << "a = " << a << std::endl;
a *= 2;
}
But it should be noted that the left shift operation will shift all bits to the left, including the sign bit, example:
int a = 2147483647; // 0111 1111 1111 1111 1111 1111 1111 1111
int b = a << 1; // 1111 1111 1111 1111 1111 1111 1111 1110
std::cout << "a = " << a << ", b = " << b << std::endl;
While some compilers will yield results that seem expected, it should be noted that if you left shift a signed number
so that the sign bit is affected, the result is undefined. It is also undefined if the number of bits you wish to shift by
is a negative number or is larger than the number of bits the type on the left can hold, example:
int a = 1;
int b = a << -1; // undefined behavior
char c = a << 20; // undefined behavior
The bit wise left shift does not change the value of the original values unless specifically assigned to using the bit
wise assignment compound operator <<=:
int a = 5; // 0101b
a <<= 1; // a = a << 1;
std::cout << "a = " << a << ", b = " << b << std::endl;
Output
a = 2, b = 1
Why
The right bit wise shift will shift the bits of the left hand value (a) the number specified on the right (1); it should be
noted that while the operation of a right shift is standard, what happens to the bits of a right shift on a signed
negative number is implementation defined and thus cannot be guaranteed to be portable, example:
int a = -2;
int b = a >> 1; // the value of b will be depend on the compiler
It is also undefined if the number of bits you wish to shift by is a negative number, example:
int a = 1;
int b = a >> -1; // undefined behavior
int a = 2; // 0010b
a >>= 1; // a = a >> 1;
Explanation
(See here for an explanation of why this works and is actually the best approach.)
Using std::bitset
std::bitset<10> x;
x.set(); // Sets all bits to '1'
Using std::bitset
std::bitset<4> num(std::string("0100"));
num.flip(2); // num is now 0000
num.flip(0); // num is now 0001
num.flip(); // num is now 1110 (flips all bits)
The value of the bit can be obtained by shifting the number to the right x times and then performing bitwise AND
(&) on it:
(number >> x) & 1LL; // 1 if the 'x'th bit of 'number' is set, 0 otherwise
The right-shift operation may be implemented as either an arithmetic (signed) shift or a logical (unsigned) shift. If
If we need the value of that bit directly in-place, we could instead left shift the mask:
(number & (1LL << x)); // (1 << x) if the 'x'th bit of 'number' is set, 0 otherwise
Either can be used as a conditional, since all non-zero values are considered true.
Using std::bitset
std::bitset<4> num(std::string("0010"));
bool bit_val = num.test(1); // bit_val value is set to true;
It goes through as many iterations as there are set bits, so it's good when value is expected to have few nonzero
bits.
The method was first proposed by Peter Wegner (in CACM 3 / 322 - 1960) and it's well known since it appears in C
Programming Language by Brian W. Kernighan and Dennis M. Ritchie.
unsigned popcount(std::uint64_t x)
{
const std::uint64_t m1 = 0x5555555555555555; // binary: 0101...
const std::uint64_t m2 = 0x3333333333333333; // binary: 00110011..
const std::uint64_t m4 = 0x0f0f0f0f0f0f0f0f; // binary: 0000111100001111
x -= (x >> 1) & m1; // put count of each 2 bits into those 2 bits
x = (x & m2) + ((x >> 2) & m2); // put count of each 4 bits into those 4 bits
x = (x + (x >> 4)) & m4; // put count of each 8 bits into those 8 bits
return (x * h01) >> 56; // left 8 bits of x + (x<<8) + (x<<16) + (x<<24) + ...
}
This kind of implementation has the best worst-case behavior (see Hamming weight for further details).
Many CPUs have a specific instruction (like x86's popcnt) and the compiler could offer a specific (non standard)
Note that without the first part of the check (n &&), 0 is incorrectly considered a power of 2.
Using std::bitset
std::bitset<5> num(std::string("01100"));
num.set(0); // num is now 01101
num.set(2); // num is still 01101
num.set(4,true); // num is now 11110
Using std::bitset
std::bitset<5> num(std::string("01100"));
num.reset(2); // num is now 01000
num.reset(0); // num is still 01000
num.set(3,false); // num is now 00000
Using std::bitset
/****************************************
convert small letter to captial letter.
========================================
a: 01100001
mask: 11011111 <-- (0xDF) 11(0)11111
:---------
a&mask: 01000001 <-- A letter
*****************************************/
#include <cstdio>
int main()
{
char op1 = 'a'; // "a" letter (i.e. small case)
int mask = 0xDF; // choosing a proper mask
return 0;
}
The result is
The cost of bit fields is slower access, as memory must be retrieved and bitwise operations applied to extract or
modify member values. These operations also add to executable size.
Here, each of these two fields will occupy 1 bit in memory. It is specified by : 1 expression after the variable names.
Base type of bit field could be any integral type (8-bit int to 64-bit int). Using unsigned type is recommended,
otherwise surprises may come.
If more bits are required, replace "1" with number of bits required. For example:
struct Date
{
unsigned int Year : 13; // 2^13 = 8192, enough for "year" representation for long time
unsigned int Month: 4; // 2^4 = 16, enough to represent 1-12 month values.
unsigned int Day: 5; // 32
};
The whole structure is using just 22 bits, and with normal compiler settings, sizeof this structure would be 4 bytes.
Usage is pretty simple. Just declare the variable, and use it like ordinary structure.
Date d;
d.Year = 2016;
d.Month = 7;
d.Day = 22;
This allows you to declare multiple variable values of a specific type and access them individually without needing
to declare a variable for each value.
The following example of an array uses the typ int, the variable name arrayOfInts, and the number of elements
[5] that the array has space for:
int arrayOfInts[5];
An array can be declared and initialized at the same time like this
When initializing an array by listing all of its members, it is not necessary to include the number of elements inside
the square brackets. It will be automatically calculated by the compiler. In the following example, it's 5:
It is also possible to initialize only the first elements while allocating more space. In this case, defining the length in
brackets is mandatory. The following will allocate an array of length 5 with partial initialization, the compiler
initializes all remaining elements with the standard value of the element type, in this case zero.
Arrays of other basic data types may be initialized in the same way.
char arrayOfChars[5]; // declare the array and allocate the memory, don't initialize
char arrayOfChars[5] = { 'a', 'b', 'c', 'd', 'e' } ; //declare and initialize
It is also important to take note that when accessing array elements, the array's element index(or position) starts
from 0.
int array[5] = { 10/*Element no.0*/, 20/*Element no.1*/, 30, 40, 50/*Element no.4*/};
std::cout << array[4]; //outputs 50
std::cout << array[0]; //outputs 10
Output:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
C++ doesn't support special syntax for indexing a multi-dimensional array. Instead such an array is viewed as an
array of arrays (possibly of arrays, and so on), and the ordinary single index notation [i] is used for each level. In
the example above m[y] refers to row y of m, where y is a zero-based index. Then this row can be indexed in turn,
e.g. m[y][x], which refers to the xth item – or column – of row y.
I.e. the last index varies fastest, and in the declaration the range of this index, which here is the number of columns
per row, is the last and “innermost” size specified.
Since C++ doesn't provide built-in support for dynamic size arrays, other than dynamic allocation, a dynamic size
matrix is often implemented as a class. Then the raw array matrix indexing notation m[y][x] has some cost, either
by exposing the implementation (so that e.g. a view of a transposed matrix becomes practically impossible) or by
adding some overhead and slight inconvenience when it's done by returning a proxy object from operator[]. And
so the indexing notation for such an abstraction can and will usually be different, both in look-and-feel and in the
order of indices, e.g. m(x,y) or m.at(x,y) or m.item(x,y).
sort( a, a + n );
for( int i = 0; i < n; ++i ) { cout << a[i] << ' '; }
cout << '\\n';
delete[] a;
}
A program that declares an array T a[n]; where n is determined a run-time, can compile with certain compilers
that support C99 variadic length arrays (VLAs) as a language extension. But VLAs are not supported by standard C++.
This example shows how to manually allocate a dynamic size array via a new[]-expression,
delete[] a;
The array allocated here has indeterminate values, but it can be zero-initialized by just adding an empty
parenthesis (), like this: new int[n](). More generally, for arbitrary item type, this performs a value-initialization.
As part of a function down in a call hierarchy this code would not be exception safe, since an exception before the
delete[] expression (and after the new[]) would cause a memory leak. One way to address that issue is to
automate the cleanup via e.g. a std::unique_ptr smart pointer. But a generally better way to address it is to just
use a std::vector: that's what std::vector is there for.
//----------------------------------- Machinery:
//----------------------------------- Usage:
#include
using namespace std;
auto main()
(void) b;
cout <}
The C idiom for array size, sizeof(a)/sizeof(a[0]), will accept a pointer as argument and will then generally yield
an incorrect result.
For C++11
std::extent<decltype(MyArray)>::value;
Example:
Up till C++17 (forthcoming as of this writing) C++ had no built-in core language or standard library utility to obtain
the size of an array, but this can be implemented by passing the array by reference to a function template, as shown
above. Fine but important point: the template size parameter is a size_t, somewhat inconsistent with the signed
Size function result type, in order to accommodate the g++ compiler which sometimes insists on size_t for
template matching.
With C++17 and later one may instead use std::size, which is specialized for arrays.
int main()
{
cout << "Sorting integers provided by you.\n";
cout << "You can indicate EOF via F6 in Windows or Ctrl+D in Unix-land.\n";
vector<int> a; // ? Zero size by default.
while( cin )
{
cout << "One number, please, or indicate EOF: ";
int const x = int_from( cin );
if( !cin.fail() ) { a.push_back( x ); } // Expands as necessary.
}
std::vector is a standard library class template that provides the notion of a variable size array. It takes care of all
the memory management, and the buffer is contiguous so a pointer to the buffer (e.g. &v[0] or v.data()) can be
passed to API functions requiring a raw array. A vector can even be expanded at run time, via e.g. the push_back
member function that appends an item.
The complexity of the sequence of n push_back operations, including the copying or moving involved in the vector
expansions, is amortized O(n). “Amortized”: on average.
Internally this is usually achieved by the vector doubling its buffer size, its capacity, when a larger buffer is needed.
E.g. for a buffer starting out as size 1, and being repeatedly doubled as needed for n=17 push_back calls, this
involves 1 + 2 + 4 + 8 + 16 = 31 copy operations, which is less than 2×n = 34. And more generally the sum of this
sequence can't exceed 2×n.
Compared to the dynamic size raw array example, this vector-based code does not require the user to supply (and
know) the number of items up front. Instead the vector is just expanded as necessary, for each new item value
specified by the user.
If you don't want a dependency on Boost or some other library, then one poor man's dynamic size matrix in C++ is
just like
vector<vector<int>> m( 3, vector<int>( 7 ) );
… where vector is std::vector. The matrix is here created by copying a row vector n times where n is the number
of rows, here 3. It has the advantage of providing the same m[y][x] indexing notation as for a fixed size raw array
matrix, but it's a bit inefficient because it involves a dynamic allocation for each row, and it's a bit unsafe because
it's possible to inadvertently resize a row.
A more safe and efficient approach is to use a single vector as storage for the matrix, and map the client code's (x, y)
to a corresponding index in that vector:
namespace my {
using Size = ptrdiff_t;
using std::initializer_list;
using std::vector;
public:
auto n_rows() const -> Size { return items_.size()/n_cols_; }
auto n_cols() const -> Size { return n_cols_; }
Matrix(): n_cols_( 0 ) {}
//--------------------------------------------- Usage:
using my::Matrix;
auto some_matrix()
-> Matrix<int>
{
return
{
{ 1, 2, 3, 4, 5, 6, 7 },
{ 8, 9, 10, 11, 12, 13, 14 },
{ 15, 16, 17, 18, 19, 20, 21 }
};
}
#include <iostream>
#include <iomanip>
using namespace std;
auto main() -> int
{
Matrix<int> const m = some_matrix();
Output:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
The above code is not industrial grade: it's designed to show the basic principles, and serve the needs of students
learning C++.
For example, one may define operator() overloads to simplify the indexing notation.
Iterators are a means of navigating and operating on a sequence of elements and are a generalized extension of
pointers. Conceptually it is important to remember that iterators are positions, not elements. For example, take the
following sequence:
A B C
+---+---+---+---+
| A | B | C | |
+---+---+---+---+
Elements are things within a sequence. Positions are places where meaningful operations can happen to the
sequence. For example, one inserts into a position, before or after element A, not into an element. Even deletion of
an element (erase(A)) is done by first finding its position, then deleting it.
One can think of an iterator as dereferencing to the value it refers to in the sequence. This is especially useful in
understanding why you should never dereference the end() iterator in a sequence:
+---+---+---+---+
| A | B | C | |
+---+---+---+---+
↑ ↑
| +-- An iterator here has no value. Do not dereference it!
+-------------- An iterator here dereferences to the value A.
In all the sequences and containers found in the C++ standard library, begin() will return an iterator to the first
position, and end() will return an iterator to one past the last position (not the last position!). Consequently, the
names of these iterators in algorithms are oftentimes labelled first and last:
+---+---+---+---+
| A | B | C | |
+---+---+---+---+
↑ ↑
| |
+- first +- last
It is also possible to obtain an iterator to any sequence, because even an empty sequence contains at least one
+---+
| |
+---+
In an empty sequence, begin() and end() will be the same position, and neither can be dereferenced:
+---+
| |
+---+
↑
|
+- empty_sequence.begin()
|
+- empty_sequence.end()
The alternative visualization of iterators is that they mark the positions between elements:
+---+---+---+
| A | B | C |
+---+---+---+
↑ ^ ^ ↑
| |
+- first +- last
and dereferencing an iterator returns a reference to the element coming after the iterator. Some situations where
this view is particularly useful are:
insert operations will insert elements into the position indicated by the iterator,
erase operations will return an iterator corresponding to the same position as the one passed in,
an iterator and its corresponding reverse iterator are located in the same .position between elements
Invalid Iterators
An iterator becomes invalidated if (say, in the course of an operation) its position is no longer a part of a sequence.
An invalidated iterator cannot be dereferenced until it has been reassigned to a valid position. For example:
std::vector<int>::iterator first;
{
std::vector<int> foo;
first = foo.begin(); // first is now valid
} // foo falls out of scope and is destroyed
// At this point first is now invalid
The many algorithms and sequence member functions in the C++ standard library have rules governing when
iterators are invalidated. Each algorithm is different in the way they treat (and invalidate) iterators.
As we know, iterators are for navigating sequences. In order to do that an iterator must migrate its position
throughout the sequence. Iterators can advance forward in the sequence and some can advance backwards:
Note, second argument of std::distance should be reachable from the first one(or, in other words first should be
less or equal than second).
Even though you can perform arithmetic operators with iterators, not all operations are defined for all types of
iterators. a = b + 3; would work for Random Access Iterators, but wouldn't work for Forward or Bidirectional
Iterators, which still can be advanced by 3 position with something like b = a; ++b; ++b; ++b;. So it is
recommended to use special functions in case you are not sure what is iterator type (for example, in a template
function accepting iterator).
Iterator Concepts
The C++ standard describes several different iterator concepts. These are grouped according to how they behave in
the sequences they refer to. If you know the concept an iterator models (behaves like), you can be assured of the
behavior of that iterator regardless of the sequence to which it belongs. They are often described in order from the
most to least restrictive (because the next iterator concept is a step better than its predecessor):
Input Iterators : Can be dereferenced only once per position. Can only advance, and only one position at a
time.
Forward Iterators : An input iterator that can be dereferenced any number of times.
Bidirectional Iterators : A forward iterator that can also advance backwards one position at a time.
Random Access Iterators : A bidirectional iterator that can advance forwards or backwards any number of
positions at a time.
Contiguous Iterators (since C++17) : A random access iterator that guaranties that underlying data is
contiguous in memory.
Algorithms can vary depending on the concept modeled by the iterators they are given. For example, although
random_shuffle can be implemented for forward iterators, a more efficient variant that requires random access
iterators could be provided.
Iterator traits
Iterator traits provide uniform interface to the properties of iterators. They allow you to retrieve value, difference,
pointer, reference types and also category of iterator:
template<class Iter>
Iter find(Iter first, Iter last, typename std::iterator_traits<Iter>::value_type val) {
while (first != last) {
if (*first == val)
return first;
++first;
}
return last;
}
template<class BidirIt>
template<class ForwIt>
void test(ForwIt a, std::forward_iterator_tag) {
std::cout << "Forward iterator is used" << std::endl;
}
template<class Iter>
void test(Iter a) {
test(a, typename std::iterator_traits<Iter>::iterator_category());
}
Categories of iterators are basically iterators concepts, except Contiguous Iterators don't have their own tag, since it
was found to break code.
If the vector object is const, both begin and end return a const_iterator. If you want a const_iterator to be
returned even if your vector is not const, you can use cbegin and cend.
Example:
#include <vector>
#include <iostream>
int main() {
std::vector<int> v = { 1, 2, 3, 4, 5 }; //intialize vector using an initializer_list
return 0;
}
Output:
12345
If a map object is const-qualified, the function returns a const_iterator. Otherwise, it returns an iterator.
Output:
a => 200
b => 100
c => 300
To iterate backwards use rbegin() and rend() as the iterators for the end of the collection, and the start of the
collection respectively.
A reverse iterator can be converted to a forward iterator via the base() member function. The relationship is that
the reverse iterator references one element past the base() iterator:
std::vector<int>::reverse_iterator r = v.rbegin();
std::vector<int>::iterator i = r.base();
assert(&*r == &*(i-1)); // always true if r, (i-1) are dereferenceable
// and are not proxy iterators
+---+---+---+---+---+---+---+
| | 1 | 2 | 3 | 4 | 5 | |
+---+---+---+---+---+---+---+
↑ ↑ ↑ ↑
| | | |
rend() | rbegin() end()
| rbegin().base()
begin()
rend().base()
In the visualization where iterators mark positions between elements, the relationship is simpler:
+---+---+---+---+---+
| 1 | 2 | 3 | 4 | 5 |
+---+---+---+---+---+
↑ ↑
| |
| end()
| rbegin()
begin() rbegin().base()
rend()
rend().base()
// Constructing stream iterators and copying data from stream into vector.
std::copy(
// Iterator which will read stream data as integers.
std::istream_iterator<int>(istr),
// Default constructor produces end-of-stream iterator.
std::istream_iterator<int>(),
std::back_inserter(v));
#ifdef BEFORE_CPP11
// You can use `sizeof` to determine how many elements are in an array.
const int* first = array;
const int* afterLast = first + sizeof(array) / sizeof(array[0]);
// Then you can iterate over the array by incrementing a pointer until
// it reaches past the end of our array.
for (const int* i = first; i < afterLast; ++i) {
std::cout << *i << std::endl;
}
#else
// With C++11, you can let the STL compute the start and end iterators:
for (auto i = std::begin(array); i != std::end(array); ++i) {
std::cout << *i << std::endl;
}
#endif
This code would output the numbers 1 through 5, one on each line like this:
1
2
3
4
Breaking It Down
const int array[] = { 1, 2, 3, 4, 5 };
This line creates a new integer array with 5 values. C arrays are just pointers to memory where each value is stored
together in a contiguous block.
These lines create two pointers. The first pointer is given the value of the array pointer, which is the address of the
first element in the array. The sizeof operator when used on a C array returns the size of the array in bytes.
Divided by the size of an element this gives the number of elements in the array. We can use this to find the
address of the block after the array.
Here we create a pointer which we will use as an iterator. It is initialized with the address of the first element we
want to iterate over, and we'll continue to iterate as long as i is less than afterLast, which means as long as i is
pointing to an address within array.
Finally, within the loop we can access the value our iterator i is pointing to by dereferencing it. Here the
dereference operator * returns the value at the address in i.
template<class T>
struct generator_iterator {
using difference_type=std::ptrdiff_t;
using value_type=T;
using pointer=T*;
using reference=T;
using iterator_category=std::input_iterator_tag;
std::optional<T> state;
std::function< std::optional<T>() > operation;
// we store the current element in "state" if we have one:
T operator*() const {
return *state;
}
// to advance, we invoke our operation. If it returns a nullopt
// we have reached the end:
generator_iterator& operator++() {
state = operation();
return *this;
}
generator_iterator operator++(int) {
auto r = *this;
live example.
We store the generated element early so we can more easily detect if we are already at the end.
As the function of an end generator iterator is never used, we can create a range of generator iterators by only
copying the std::function once. A default constructed generator iterator compares equal to itself, and to all other
end-generator-iterators.
int main()
{
int value;
std::cout << "Enter a value: " << std::endl;
std::cin >> value;
std::cout << "The square of entered value is: " << value * value << std::endl;
return 0;
}
for loops can be used to iterate over the elements of a iterator-based range, without using a numeric index or
directly accessing the iterators:
for(auto val: v)
{
std::cout << val << " ";
}
This will iterate over every element in v, with val getting the value of the current element. The following statement:
is equivalent to:
{
auto&& __range = for-range-initializer;
auto __begin = begin-expr, __end = end-expr;
for (; __begin != __end; ++__begin) {
for-range-declaration = *__begin;
statement
}
}
Version ≥ C++17
{
auto&& __range = for-range-initializer;
auto __begin = begin-expr;
auto __end = end-expr; // end is allowed to be a different type than begin in C++17
for (; __begin != __end; ++__begin) {
for-range-declaration = *__begin;
statement
}
}
This change was introduced for the planned support of Ranges TS in C++20.
{
auto&& __range = v;
auto __begin = v.begin(), __end = v.end();
for (; __begin != __end; ++__begin) {
auto val = *__begin;
std::cout << val << " ";
Note that auto val declares a value type, which will be a copy of a value stored in the range (we are copy-initializing
it from the iterator as we go). If the values stored in the range are expensive to copy, you may want to use const
auto &val. You are also not required to use auto; you can use an appropriate typename, so long as it is implicitly
convertible from the range's value type.
If you need access to the iterator, range-based for cannot help you (not without some effort, at least).
for(float &val: v)
{
std::cout << val << " ";
}
One would use forwarding references when the sequence iterator returns a proxy object and you need to operate
on that object in a non-const way. Note: it will most likely confuse readers of your code.
vector<bool> v(10);
for(auto&& val: v)
{
val = true;
}
The "range" type provided to range-based for can be one of the following:
Language arrays:
struct Rng
{
float arr[3];
int main()
{
Rng rng = {{0.4f, 12.5f, 16.234f}};
Any type which has non-member begin(type) and end(type) functions which can found via argument
dependent lookup, based on type. This is useful for creating a range type without having to modify class type
itself:
namespace Mine
{
struct Rng {float arr[3];};
int main()
{
Mine::Rng rng = {{0.4f, 12.5f, 16.234f}};
initialization statement: This statement gets executed only once, at the beginning of the for loop. You
can enter a declaration of multiple variables of one type, such as int i = 0, a = 2, b = 3. These variables
are only valid in the scope of the loop. Variables defined before the loop with the same name are hidden
during execution of the loop.
condition: This statement gets evaluated ahead of each loop body execution, and aborts the loop if it
evaluates to false.
iteration execution: This statement gets executed after the loop body, ahead of the next condition
evaluation, unless the for loop is aborted in the body (by break, goto, return or an exception being thrown).
You can enter multiple statements in the iteration execution part, such as a++, b+=10, c=b+a.
/*initialization*/
while (/*condition*/)
{
// body of the loop; using 'continue' will skip to increment part below
/*iteration execution*/
}
The most common case for using a for loop is to execute statements a specific number of times. For example,
consider the following:
But if you want to use the already declared variable and not hide it, then omit the declaration part:
Notes:
int counter = 0 initializes the variable counter to 0. (This variable can only be used inside of the for loop.)
counter <= 10 is a Boolean condition that checks whether counter is less than or equal to 10. If it is true,
the loop executes. If it is false, the loop ends.
++counter is an increment operation that increments the value of counter by 1 ahead of the next condition
check.
// infinite loop
for (;;)
std::cout << "Never ending!\n";
// infinite loop
while (true)
std::cout << "Never ending!\n";
However, an infinite loop can still be left by using the statements break, goto, or return or by throwing an
exception.
The next common example of iterating over all elements from an STL collection (e.g., a vector) without using the
<algorithm> header is:
For example, to print all the numbers from 0 up to 9, the following code can be used:
int i = 0;
while (true)
{
// Do something forever (however, you can exit the loop by calling 'break'
}
There is another variant of while loops, namely the do...while construct. See the do-while loop example for more
information.
The following code will print 0, as the condition will evaluate to false at the end of the first iteration:
int i =0;
do
{
std::cout << i;
++i; // Increment counter
}
while (i < 0);
std::cout << std::endl; // End of line; 0 is printed to the console
Note: Do not forget the semicolon at the end of while(condition);, which is needed in the do-while construct.
In contrast to the do-while loop, the following will not print anything, because the condition evaluates to false at
the beginning of the first iteration:
int i =0;
while (i < 0)
{
std::cout << i;
++i; // Increment counter
}
std::cout << std::endl; // End of line; nothing is printed to the console
Note: A while loop can be exited without the condition becoming false by using a break, goto, or return statement.
int i = 0;
do
{
A trivial do-while loop is also occasionally used to write macros that require their own scope (in which case the
trailing semicolon is omitted from the macro definition and required to be provided by the user):
1
2
3
The continue statement does not immediately exit the loop, but rather skips the rest of the loop body and goes to
the top of the loop (including checking the condition).
Because such control flow changes are sometimes difficult for humans to easily understand, break and continue
are used sparingly. More straightforward implementation are usually easier to read and understand. For example,
the first for loop with the break above might be rewritten as:
while(std::shared_ptr<Object> p = get_object()) {
p->do_something();
}
// p is no longer in scope.
However, it is not permitted to do the same with a do...while loop; instead, declare the variable before the loop,
and (optionally) enclose both the variable and the loop within a local scope if you want the variable to go out of
scope after the loop ends:
// Good
short s;
do {
s = do_something();
} while (s > 0);
template<class C>
auto except_first( C& c ) {
auto r = range(c);
if (r.empty()) return r;
return r.without_front();
}
std::vector<int> v = {1,2,3,4};
Be aware that intermediate objects generated in the for(:range_expression) part of the for loop will have
expired by the time the for loop starts.
Streams use std::locale, e.g., for details of the formatting and for translation between external encodings and the
internal encoding.
std::ofstream os("foo.txt");
if(os.is_open()){
os << "Hello World!";
}
Instead of <<, you can also use the output file stream's member function write():
std::ofstream os("foo.txt");
if(os.is_open()){
char data[] = "Foo";
After writing to a stream, you should always check if error state flag badbit has been set, as it indicates whether the
operation failed or not. This can be done by calling the output file stream's member function bad():
os << "Hello Badbit!"; // This operation might fail for any reason.
if (os.bad())
// Failed to write!
Alternatively, you can use the file stream's member function open():
std::ifstream ifs;
ifs.open("bar.txt"); // ifstream: Opens file "bar.txt" for reading only.
std::ofstream ofs;
ofs.open("bar.txt"); // ofstream: Opens file "bar.txt" for writing only.
std::fstream iofs;
iofs.open("bar.txt"); // fstream: Opens file "bar.txt" for reading and writing.
You should always check if a file has been opened successfully (even when writing). Failures can include: the file
doesn't exist, file hasn't the right access rights, file is already in use, disk errors occurred, drive disconnected ...
Checking can be done as follows:
When file path contains backslashes (for example, on Windows system) you should properly escape them:
If you want to open file with non-ASCII characters in path on Windows currently you can use non-standard wide
character path argument:
If you know how the data is formatted, you can use the stream extraction operator (>>). Let's assume you have a file
named foo.txt which contains the following data:
Then you can use the following code to read that data from the file:
// Define variables.
std::ifstream is("foo.txt");
std::string firstname, lastname;
int age, bmonth, bday, byear;
// Extract firstname, lastname, age, bday month, bday day, and bday year in that order.
// Note: '>>' returns false if it reached EOF (end of file) or if the input data doesn't
// correspond to the type of the input variable (for example, the string "foo" can't be
// extracted into an 'int' variable).
while (is >> firstname >> lastname >> age >> bmonth >> bday >> byear)
// Process the data that has been read.
The stream extraction operator >> extracts every character and stops if it finds a character that can't be stored or if
it is a special character:
This means that the following version of the file foo.txt will also be successfully read by the previous code:
John
Doe 25
4 6 1987
Jane
Doe
15 5
24
1976
The stream extraction operator >> always returns the stream given to it. Therefore, multiple operators can be
chained together in order to read data consecutively. However, a stream can also be used as a Boolean expression
(as shown in the while loop in the previous code). This is because the stream classes have a conversion operator
for the type bool. This bool() operator will return true as long as the stream has no errors. If a stream goes into an
error state (for example, because no more data can be extracted), then the bool() operator will return false.
Therefore, the while loop in the previous code will be exited after the input file has been read to its end.
If you wish to read an entire file as a string, you may use the following code:
// Opens 'foo.txt'.
std::ifstream is("foo.txt");
std::string whole_file;
This code reserves space for the string in order to cut down on unneeded memory allocations.
If you want to read a file line by line, you can use the function getline():
std::ifstream is("foo.txt");
If you want to read a fixed number of characters, you can use the stream's member function read():
std::ifstream is("foo.txt");
char str[4];
After executing a read command, you should always check if the error state flag failbit has been set, as it
indicates whether the operation failed or not. This can be done by calling the file stream's member function fail():
if (is.fail())
// Failed to read!
An opening mode can be provided as second parameter to the constructor of a file stream or to its open() member
function:
std::ifstream is;
is.open("foo.txt", std::ios::in | std::ios::binary);
It is to be noted that you have to set ios::in or ios::out if you want to set other flags as they are not implicitly set
by the iostream members although they have a correct default value.
If you don't specify an opening mode, then the following default modes are used:
ifstream - in
ofstream - out
fstream - in and out
The file opening modes that you may specify by design are:
Note: Setting the binary mode lets the data be read/written exactly as-is; not setting it enables the translation of
the newline '\n' character to/from a platform specific end of line sequence.
if (f)
{
std::stringstream buffer;
buffer << f.rdbuf();
f.close();
The rdbuf() method returns a pointer to a streambuf that can be pushed into buffer via the
stringstream::operator<< member function.
std::ifstream f("file.txt");
if (f)
{
std::string str((std::istreambuf_iterator<char>(f)),
std::istreambuf_iterator<char>());
// Operations on `str`...
}
This is nice because requires little code (and allows reading a file directly into any STL container, not only strings)
but can be slow for big files.
NOTE: the extra parentheses around the first argument to the string constructor are essential to prevent the most
vexing parse problem.
std::ifstream f("file.txt");
if (f)
{
f.seekg(0, std::ios::end);
const auto size = f.tellg();
// Operations on `str`...
}
You should always apply a local to a stream before opening the file.
Once the stream has been imbued you should not change the locale.
Reasons for Restrictions: Imbuing a file stream with a locale has undefined behavior if the current locale is not
state independent or not pointing at the beginning of the file.
UTF-8 streams (and others) are not state independent. Also a file stream with a UTF-8 locale may try and read the
BOM marker from the file when it is opened; so just opening the file may read characters from the file and it will
not be at the beginning.
#include <iostream>
#include <fstream>
#include <locale>
int main()
{
std::cout << "User-preferred locale setting is "
<< std::locale("").name().c_str() << std::endl;
Explicitly switching to the classic "C" locale is useful if your program uses a different default locale and you want to
ensure a fixed standard for reading and writing files. With a "C" preferred locale, the example writes
If, for example, the preferred locale is German and hence uses a different number format, the example writes
78 123,456
78,123.456
78123.456
while (!f.eof())
{
// Everything is OK
f >> buffer;
/* Use `buffer` */
}
while (!f.eof())
{
f >> buffer >> std::ws;
if (f.fail())
break;
/* Use `buffer` */
}
but
Further references:
std::ofstream os("foo.txt");
os << "Hello World!" << std::flush;
There is a stream manipulator std::endl that combines writing a newline with flushing the stream:
Buffering can improve the performance of writing to a stream. Therefore, applications that do a lot of writing
should avoid flushing unnecessarily. Contrary, if I/O is done infrequently, applications should consider flushing
frequently in order to avoid data getting stuck in the stream object.
std::ifstream file("file3.txt");
std::vector<std::string> v;
std::string s;
while(file >> s) // keep reading until we run out
{
v.push_back(s);
}
In the above example we are simply iterating through the file reading one "item" at a time using operator>>. This
same affect can be achieved using the std::istream_iterator which is an input iterator that reads one "item" at a
time from the stream. Also most containers can be constructed using two iterators so we can simplify the above
code to:
std::ifstream file("file3.txt");
std::vector<std::string> v(std::istream_iterator<std::string>{file},
std::istream_iterator<std::string>{});
We can extend this to read any object types we like by simply specifying the object we want to read as the template
parameter to the std::istream_iterator. Thus we can simply extend the above to read lines (rather than words)
like this:
std::ifstream file("file3.txt");
With C++17 the standard way to copy a file is including the <filesystem> header and using copy_file:
std::fileystem::copy_file("source_filename", "dest_filename");
The filesystem library was originally developed as boost.filesystem and finally merged to ISO C++ as of C++17.
// Write data.
output << prepared_data;
} // The ofstream will go out of scope here.
// Its destructor will take care of closing the file properly.
Calling close() explicitly is only necessary if you want to reuse the same fstream object later, but don't want to
keep the file open in between:
// Preparing data might take a long time. Therefore, we don't open the output file stream
// before we actually can write some data to it.
std::string const more_prepared_data = prepare_complex_data();
// Open the file "foo.txt" for the second time once we are ready for writing.
output.open("foo.txt");
void func4()
{
auto file = std::ifstream("file4.txt");
std::vector<info_type> v;
for(info_type info; file >> info;) // keep reading until we run out
{
// we only get here if the read succeeded
v.push_back(info);
}
Wogger Wabbit
2
6.2
Bilbo Baggins
111
81.3
Mary Poppins
29
154.8
Output:
#include <sstream>
#include <string>
int main()
{
ostringstream ss;
ss << "the answer to everything is " << 42;
const string result = ss.str();
}
The line
ostringstream ss;
creates such an object. This object is first manipulated like a regular stream:
Following that, though, the resulting stream can be obtained like this:
This is mainly useful when we have a class for which stream serialization has been defined, and for which we want a
string form. For example, suppose we have some class
class foo
{
// All sort of stuff here.
};
foo f;
we could use
ostringstream ss;
ss << f;
const string result = ss.str();
std::ostream_iterator allows to print contents of an STL container to any output stream without explicit loops.
The second argument of std::ostream_iterator constructor sets the delimiter. For example, the following code:
std::vector<int> v = {1,2,3,4};
std::copy(v.begin(), v.end(), std::ostream_iterator<int>(std::cout, " ! "));
will print
1 ! 2 ! 3 ! 4 !
std::ostream_iterator allows to cast container's content type implicitly. For example, let's tune std::cout to print
floating-point values with 3 digits after decimal point:
and instantiate std::ostream_iterator with float, while the contained values remain int:
std::vector<int> v = {1,2,3,4};
std::copy(v.begin(), v.end(), std::ostream_iterator<float>(std::cout, " ! "));
std::generate, std::generate_n and std::transform functions provide a very powerful tool for on-the-fly data
manipulation. For example, having a vector:
std::vector<int> v = {1,2,3,4,8,16};
we can easily print boolean value of "x is even" statement for each element:
Arrays
As in the section about reading text files, almost all these considerations may be applied to native arrays. For
example, let's print squared values from a native array:
bool boolValue;
std::cin >> std::boolalpha >> boolValue;
std::cout << "Value \"" << std::boolalpha << boolValue
<< "\" was parsed as " << std::noboolalpha << boolValue;
// Input: true
// Output: Value "true" was parsed as 0
std::showbase and std::noshowbase - control whether prefix indicating numeric base is used.
std::dec (decimal), std::hex (hexadecimal) and std::oct (octal) - are used for changing base for integers.
#include <sstream>
If you want to see more about std::istringstream check out the <sstream> header.
std::uppercase and std::nouppercase - control whether uppercase characters are used in floating-point and
hexadecimal integer output. Have no effect on input streams.
The width property n is resetting to 0 when some functions are called (full list is here).
// Output: 51
// setw(7): 51
// setw(7), more output: 13*****67 94
Default is std::setw(0).
std::left, std::right and std::internal - modify the default position of the fill characters by setting
std::ios_base::adjustfield to std::ios_base::left, std::ios_base::right and std::ios_base::internal
correspondingly. std::left and std::right apply to any output, std::internal - for integer, floating-point and
monetary output. Have no effect on input streams.
#include <locale>
...
std::cout.imbue(std::locale("en_US.utf8"));
Default is std::left.
std::fixed, std::scientific, std::hexfloat [C++11] and std::defaultfloat [C++11] - change formatting for
floating-point input/output.
fmtflags
#include <sstream>
...
double f;
std::istringstream is("0x1P-1022");
double f = std::strtod(is.str().c_str(), NULL);
std::cout << "Parsing 0x1P-1022 as hex gives " << f << '\n';
// Output:
// The number 0.01 in fixed: 0.070000
// The number 0.01 in scientific: 7.000000e-02
// The number 0.01 in hexfloat: 0x1.1eb851eb851ecp-4
// The number 0.01 in default: 0.07
// Parsing 0x1P-1022 as hex gives 2.22507e-308
Default is std::ios_base::fmtflags(0).
std::showpoint and std::noshowpoint - control whether decimal point is always included in floating-point
representation. Have no effect on input streams.
std::cout << "7.0 with showpoint: " << std::showpoint << 7.0 << '\n'
<< "7.0 with noshowpoint: " << std::noshowpoint << 7.0 << '\n';
// Output: 1.0 with showpoint: 7.00000
// 1.0 with noshowpoint: 7
Default is std::showpoint.
std::showpos and std::noshowpos - control displaying of the + sign in non-negative output. Have no effect on input
streams.
Default if std::noshowpos.
std::unitbuf, std::nounitbuf - control flushing output stream after every operation. Have no effect on input
stream. std::unitbuf causes flushing.
#include <cmath>
#include <limits>
...
// Output:
// default precision (6): pi: 3.14159
// 10pi: 31.4159
// std::setprecision(4): 10pi: 31.42
// 10000pi: 3.142e+04
// std::fixed: 10000pi: 31415.9265
// std::setprecision(10): pi: 3.141592654
// max-1 radix precicion: pi: 3.14159265358979323851280895940618620443274267017841339111328125
// max+1 radix precision: pi: 3.14159265358979323851280895940618620443274267017841339111328125
// significant digits prec: pi: 3.14159265358979324
Default is std::setprecision(6).
#include <sstream>
...
std::skipws and std::noskipws - control skipping of leading whitespace by the formatted input functions. Have no
effect on output streams.
#include <sstream>
Default is std::ios_base::skipws.
std::quoted(s[, delim[, escape]]) [C++14] - inserts or extracts quoted strings with embedded spaces.
#include <sstream>
...
std::stringstream ss;
std::string in = "String with spaces, and embedded \"quotes\" too";
std::string out;
ss << std::quoted(in);
std::cout << "read in [" << in << "]\n"
<< "stored as [" << ss.str() << "]\n";
ss >> std::quoted(out);
std::cout << "written out [" << out << "]\n";
// Output:
// read in [String with spaces, and embedded "quotes" too]
// stored as ["String with spaces, and embedded \"quotes\" too"]
// written out [String with spaces, and embedded "quotes" too]
and this manipulator places character by calling os.put(charT()) when used in an expression
os << std::ends;
std::endl and std::flush both flush output stream out by calling out.flush(). It causes immediately producing
output. But std::endl inserts end of line '\n' symbol before flushing.
std::cout << "First line." << std::endl << "Second line. " << std::flush
<< "Still second line.";
std::cout << "\nDefault fill: " << std::setw(10) << 79 << '\n'
<< "setfill('#'): " << std::setfill('#')
<< std::setw(10) << 42 << '\n';
// Output:
// Default fill: 79
// setfill('#'): ########79
std::put_money(mon[, intl]) [C++11]. In an expression out << std::put_money(mon, intl), converts the
monetary value mon (of long double or std::basic_string type) to its character representation as specified by the
std::money_put facet of the locale currently imbued in out. Use international currency strings if intl is true, use
currency symbols otherwise.
std::cout.imbue(std::locale("en_US.utf8"));
std::cout << std::showbase << "en_US: " << std::put_money(money)
<< " or " << std::put_money(money, true) << '\n';
// Output: en_US: $1.23 or USD 1.23
std::cout.imbue(std::locale("ru_RU.utf8"));
std::cout << "ru_RU: " << std::put_money(money)
<< " or " << std::put_money(money, true) << '\n';
// Output: ru_RU: 1.23 ??? or 1.23 RUB
std::cout.imbue(std::locale("ja_JP.utf8"));
std::cout << "ja_JP: " << std::put_money(money)
<< " or " << std::put_money(money, true) << '\n';
// Output: ja_JP: ?123 or JPY 123
std::put_time(tmb, fmt) [C++11] - formats and outputs a date/time value to std::tm according to the specified
format fmt.
tmb - pointer to the calendar time structure const std::tm* as obtained from localtime() or gmtime().
fmt - pointer to a null-terminated string const CharT* specifying the format of conversion.
#include <ctime>
...
std::time_t t = std::time(nullptr);
std::tm tm = *std::localtime(&t);
std::cout.imbue(std::locale("ru_RU.utf8"));
std::cout << "\nru_RU: " << std::put_time(&tm, "%c %Z") << '\n';
// Possible output:
// ru_RU: ?? 04 ??? 2017 15:08:35 UTC
#include <sstream>
...
std::string str;
std::istringstream(" \v\n\r\t Wow!There is no whitespaces!") >> std::ws >> str;
std::cout << str;
// Output: Wow!There is no whitespaces!
std::get_money(mon[, intl]) [C++11]. In an expression in >> std::get_money(mon, intl) parses the character
input as a monetary value, as specified by the std::money_get facet of the locale currently imbued in in, and stores
the value in mon (of long double or std::basic_string type). Manipulator expects required international currency
strings if intl is true, expects optional currency symbols otherwise.
#include <sstream>
#include <locale>
...
in.imbue(std::locale("en_US.UTF-8"));
in >> std::get_money(v1) >> std::get_money(v2) >> std::get_money(v3, true);
if (in) {
std::cout << std::quoted(in.str()) << " parsed as: "
<< v1 << ", " << v2 << ", " << v3 << '\n';
}
// Output:
// "$1,234.56 2.22 USD 3.33" parsed as: 123456, 222, 333
std::get_time(tmb, fmt) [C++11] - parses a date/time value stored in tmb of specified format fmt.
tmb - valid pointer to the const std::tm* object where the result will be stored.
fmt - pointer to a null-terminated string const CharT* specifying the conversion format.
#include <sstream>
#include <locale>
...
std::tm t = {};
std::istringstream ss("2011-Februar-18 23:12:34");
ss.imbue(std::locale("de_DE.utf-8"));
ss >> std::get_time(&t, "%Y-%b-%d %H:%M:%S");
if (ss.fail()) {
std::cout << "Parse failed\n";
}
else {
std::cout << std::put_time(&t, "%c") << '\n';
}
// Possible output:
// Sun Feb 18 23:12:34 2011
char c = getchar();
bool confirmed;
switch (c) {
case 'y':
confirmed = true;
break;
case 'n':
confirmed = false;
break;
default:
std::cout << "invalid response!\n";
abort();
}
The switch statement causes control to be transferred to one of several statements depending on the
value of a condition.
The keyword switch is followed by a parenthesized condition and a block, which may contain case labels and an
optional default label. When the switch statement is executed, control will be transferred either to a case label
with a value matching that of the condition, if any, or to the default label, if any.
The condition must be an expression or a declaration, which has either integer or enumeration type, or a class type
with a conversion function to integer or enumeration type.
char c = getchar();
bool confirmed;
switch (c) {
case 'y':
confirmed = true;
break;
case 'n':
confirmed = false;
break;
default:
std::cout << "invalid response!\n";
abort();
}
try {
std::vector<int> v(N);
// do something
} catch (const std::bad_alloc&) {
std::cout << "failed to allocate memory for vector!" << std::endl;
} catch (const std::runtime_error& e) {
std::cout << "runtime error: " << e.what() << std::endl;
} catch (...) {
std::cout << "unexpected exception!" << std::endl;
throw;
}
2. When throw occurs in an expression without an operand, its effect is to rethrow the current exception. If
there is no current exception, std::terminate is called.
try {
// something risky
} catch (const std::bad_alloc&) {
std::cerr << "out of memory" << std::endl;
} catch (...) {
std::cerr << "unexpected exception" << std::endl;
// hope the caller knows how to handle this exception
throw;
}
3. When throw occurs in a function declarator, it introduces a dynamic exception specification, which lists the
types of exceptions that the function is allowed to propagate.
Note that the first two uses of throw listed above constitute expressions rather than statements. (The type of a
throw expression is void.) This makes it possible to nest them within expressions, like so:
char c = getchar();
bool confirmed;
switch (c) {
case 'y':
confirmed = true;
break;
case 'n':
confirmed = false;
break;
default:
std::cout << "invalid response!\n";
abort();
}
Version ≥ C++11
Defines a default constructor, copy constructor, move constructor, destructor, copy assignment operator, or move
assignment operator to have its default behaviour.
class Base {
// ...
// we want to be able to delete derived classes through Base*,
// but have the usual behaviour for Base's destructor.
virtual ~Base() = default;
};
Section 16.7: if
Introduces an if statement. The keyword if must be followed by a parenthesized condition, which can be either an
expression or a declaration. If the condition is truthy, the substatement after the condition will be executed.
int x;
int x;
std::cin >> x;
if (x%2 == 0) {
std::cout << "The number is even\n";
} else {
std::cout << "The number is odd\n";
}
it used to check whether the given expression returns true or false and acts as such:
if (condition) statement
the condition can be any valid C++ expression that returns something that be checked against truth/falsehood for
example:
if (true) { /* code here */ } // evaluate that true is true and execute the code in the brackets
if (false) { /* code here */ } // always skip the code since false is always false
if(istrue()) { } // evaluate the function, if it returns true, the if will execute the code
if(isTrue(var)) { } //evaluate the return of the function after passing the argument var
if(a == b) { } // this will evaluate the return of the experssion (a==b) which will be true if
equal and false if unequal
if(a) { } //if a is a boolean type, it will evaluate for its value, if it's an integer, any non
zero value will be true,
if (a && b) { } // will be true only if both a and b are true (binary operators are outside the
scope here
if (a || b ) { } //true if a or b is true
using if/ifelse/else:
if (a== "test") {
if (a=='a') {
// if a is a char valued 'a'
} else if (a=='b') {
// if a is a char valued 'b'
} else if (a=='c') {
// if a is a char valued 'c'
} else {
//if a is none of the above
}
however it must be noted that you should use 'switch' instead if your code checks for the same variable's value
Using break we can leave a loop even if the condition for its end is not fulfilled. It can be used to end an infinite
loop, or to force it to end before its natural end
The syntax is
break;
Example: we often use break in switch cases,ie once a case i switch is satisfied then the code block of that
condition is executed .
switch(conditon){
case 1: block1;
case 2: block2;
case 3: block3;
default: blockdefault;
}
switch(condition){
case 1: block1;
break;
case 2: block2;
break;
case 3: block3;
break;
default: blockdefault;
break;
}
so only one block is processed and the control moves out of the switch loop.
break can also be used in other conditional and non conditional loops like if,while,for etc;
example:
if(condition1){
....
if(condition2){
.......
break;
}
...
}
The continue instruction causes the program to skip the rest of the loop in the present iteration as if the end of the
statement block would have been reached, causing it to jump to the following iteration.
The syntax is
continue;
for(int i=0;i<10;i++){
if(i%2==0)
continue;
cout<<"\n @"<<i;
}
@1
@3
@5
@7
@9
i this code whenever the condition i%2==0 is satisfied continue is processed,this causes the compiler to skip all the
remaining code( printing @ and i) and increment/decrement statement of the loop gets executed.
It allows making an absolute jump to another point in the program. You should use this feature carefully since its
execution ignores any type of nesting limitation. The destination point is identified by a label, which is then used as
an argument for the goto instruction. A label is made of a valid identifier followed by a colon (:)
The syntax is
goto label;
..
.
label: statement;
Note: Use of goto statement is highly discouraged because it makes difficult to trace the control flow of a program,
making the program hard to understand and hard to modify.
Example :
int num = 1;
STEP:
do{
if( num%2==0 )
{
num = num + 1;
output :
value of num : 1
value of num : 3
value of num : 5
value of num : 7
value of num : 9
whenever the condition num%2==0 is satisfied the goto sends the execution control to the beginning of the do-while
loop.
exit is a function defined in cstdlib. The purpose of exit is to terminate the running program with an specific exit
code. Its prototype is:
If return has an operand, the operand is converted to the function's return type, and the converted value is
returned to the caller.
int f() {
return 42;
}
int x = f(); // x is 42
int g() {
return 3.14;
}
int y = g(); // y is 3
If return does not have an operand, the function must have void return type. As a special case, a void-returning
function can also return an expression if the expression has type void.
void f(int x) {
if (x < 0) return;
std::cout << sqrt(x);
}
int g() { return 42; }
void h() {
return f(); // calls f, then returns
return g(); // ill-formed
}
When main returns, std::exit is implicitly called with the return value, and the value is thus returned to the
In general, macros are frowned upon in this role and templates are preferred, although they are not as generic.
Template metaprogramming often makes use of compile-time computations, whether via templates or constexpr
functions, to achieve its goals of generating code, however compile-time computations are not metaprogramming
per se.
#include <iostream>
template<>
struct factorial<0>
{
enum { value = 1 };
};
int main()
{
std::cout << factorial<7>::value << std::endl; // prints "5040"
}
In the above code, we evaluate the factorial metafunction by instantiating the template with the parameters we
want to pass, and using ::value to get the result of the evaluation.
The metafunction itself relies on recursively instantiating the same metafunction with smaller values. The
factorial<0> specialization represents the terminating condition. Template metaprogramming has most of the
restrictions of a functional programming language, so recursion is the primary "looping" construct.
Since template metafunctions execute at compile time, their results can be used in contexts that require compile-
time values. For example:
int my_array[factorial<5>::value];
Automatic arrays must have a compile-time defined size. And the result of a metafunction is a compile-time
constant, so it can be used here.
Limitation: Most of the compilers won't allow recursion depth beyond a limit. For example, g++ compiler by default
Version ≥ C++11
Since C++11, the std::integral_constant template can be used for this kind of template computation:
#include <iostream>
#include <type_traits>
template<>
struct factorial<0> :
std::integral_constant<long long, 1> {};
int main()
{
std::cout << factorial<7>::value << std::endl; // prints "5040"
}
#include <iostream>
int main()
{
char test[factorial(3)];
std::cout << factorial(7) << '\n';
}
The body of factorial() is written as a single statement because in C++11 constexpr functions can only use a
quite limited subset of the language.
Version ≥ C++14
Since C++14, many restrictions for constexpr functions have been dropped and they can now be written much
more conveniently:
Or even:
#include <iostream>
#include <utility>
int main() {
std::cout << factorial<int, 5>::value << std::endl;
}
Version ≥ C++11
void print_all(std::ostream& os) {
// base case
}
print_all(os, rest...);
}
We could instead use the expander trick, to perform all the streaming in a single function. This has the advantage of
not needing a second overload, but has the disadvantage of less than stellar readability:
Version ≥ C++11
template <class... Ts>
void print_all(std::ostream& os, Ts const&... args) {
using expander = int[];
(void)expander{0,
(void(os << args), 0)...
};
}
Version ≥ C++17
With C++17, we get two powerful new tools in our arsenal for solving this problem. The first is a fold-expression:
And the second is if constexpr, which allows us to write our original recursive solution in a single function:
template<std::size_t N>
using make_index_sequence = make_integer_sequence<std::size_t, N>;
While this comes standard in C++14, this can be implemented using C++11 tools.
We can use this tool to call a function with a std::tuple of arguments (standardized in C++17 as std::apply):
namespace detail {
template <class F, class Tuple, std::size_t... Is>
decltype(auto) apply_impl(F&& f, Tuple&& tpl, std::index_sequence<Is...> ) {
return std::forward<F>(f)(std::get<Is>(std::forward<Tuple>(tpl))...);
}
}
namespace details {
template <class RAIter, class Distance>
void advance(RAIter& it, Distance n, std::random_access_iterator_tag) {
it += n;
}
The std::XY_iterator_tag arguments of the overloaded details::advance functions are unused function
parameters. The actual implementation does not matter (actually it is completely empty). Their only purpose is to
allow the compiler to select an overload based on which tag class details::advance is called with.
In this example, advance uses the iterator_traits<T>::iterator_category metafunction which returns one of
the iterator_tag classes, depending on the actual type of Iter. A default-constructed object of the
iterator_category<Iter>::type then lets the compiler select one of the different overloads of details::advance.
(This function parameter is likely to be completely optimized away, as it is a default-constructed object of an empty
struct and never used.)
Tag dispatching can give you code that's much easier to read than the equivalents using SFINAE and enable_if.
Note: while C++17's if constexpr may simplify the implementation of advance in particular, it is not suitable for open
implementations unlike tag dispatching.
template<class T>
struct has_hash<T, decltype(std::hash<T>()(std::declval<T>()), void())>
: std::true_type
{};
Version ≥ C++17
template<class T>
struct has_hash<T, std::void_t< decltype(std::hash<T>()(std::declval<T>())) > >
: std::true_type
{};
For detecting if an operator, such as operator< is defined, the syntax is almost the same:
template<class T>
struct has_less_than<T, decltype(std::declval<T>() < std::declval<T>(), void())>
: std::true_type
{};
These can be used to use a std::unordered_map<T> if T has an overload for std::hash, but otherwise attempt to
use a std::map<T>:
The type std::conditional in the standard library header <type_traits> can select one type or the other, based
on a compile-time boolean value:
template<typename T>
struct ValueOrPointer
{
typename std::conditional<(sizeof(T) > sizeof(void*)), T*, T>::type vop;
};
This struct contains a pointer to T if T is larger than the size of a pointer, or T itself if it is smaller or equal to a
pointer's size. Therefore sizeof(ValueOrPointer) will always be <= sizeof(void*).
To help us with that, the standard already provides two types analog to true and false which are std::true_type
and std::false_type.
The following example show how to detect if a type T is a pointer or not, the is_pointer template mimic the
behavior of the standard std::is_pointer helper:
There are three steps in the above code (sometimes you only need two):
1. The first declaration of is_pointer_ is the default case, and inherits from std::false_type. The default case
should always inherit from std::false_type since it is analogous to a "false condition".
2. The second declaration specialize the is_pointer_ template for pointer T* without caring about what T is
really. This version inherits from std::true_type.
3. The third declaration (the real one) simply remove any unnecessary information from T (in this case we
remove const and volatile qualifiers) and then fall backs to one of the two previous declarations.
Use ::value, e.g. is_pointer<int>::value – value is a static class member of type bool inherited from
std::true_type or std::false_type;
Construct an object of this type, e.g. is_pointer<int>{} – This works because std::is_pointer inherits its
default constructor from std::true_type or std::false_type (which have constexpr constructors) and both
std::true_type and std::false_type have constexpr conversion operators to bool.
In C++17 and above, most helper templates already provide a _v version, e.g.:
Keyword constexpr is responsible for calculating function in compilation time, then and only then, when all the
requirements for this will be met (see more at constexpr keyword reference) for example all the arguments must
be known at compile time.
Note: In C++11 constexpr function must compose only from one return statement.
Advantages: Comparing this to the standard way of compile time calculation, this method is also useful for runtime
calculations. It means, that if the arguments of the function are not known at the compilation time (e.g. value and
power are given as input via user), then function is run in a compilation time, so there's no need to duplicate a code
(as we would be forced in older standards of C++).
E.g.
void useExample() {
constexpr int compileTimeCalculated = calculatePower(3, 3); // computes at compile time,
// as both arguments are known at compilation time
// and used for a constant expression.
int value;
std::cin >> value;
int runtimeCalculated = calculatePower(value, 3); // runtime calculated,
// because value is known only at runtime.
}
Version ≥ C++17
Another way to calculate power at compile time can make use of fold expression as follows:
#include <iostream>
#include <utility>
It's possible to write a generic function (for example min) which accepts various numerical types and arbitrary
argument count by template meta-programming. This function declares a min for two arguments and recursively
for more.
Let Foo be a class, that has two methods that perform identical operations and returns a reference to an object of
type Bar:
class Foo
{
public:
Bar& GetBar(/* some arguments */)
{
/* some calculations */
return bar;
}
// ...
};
The only difference between them is that one method is non-const and return a non-const reference (that can be
use to modify object) and the second is const and returns const reference.
To avoid the code duplication, there is a temptation to call one method from another. However, we can not call
non-const method from the const one. But we can call const method from non-const one. That will require as to
use 'const_cast' to remove the const qualifier.
struct Foo
{
Bar& GetBar(/*arguments*/)
{
return const_cast<Bar&>(const_cast<const Foo*>(this)->GetBar(/*arguments*/));
}
In code above, we call const version of GetBar from the non-const GetBar by casting this to const type:
const_cast<const Foo*>(this). Since we call const method from non-const, the object itself is non-const, and
casting away the const is allowed.
#include <iostream>
class Student
{
public:
char& GetScore(bool midterm)
{
return const_cast<char&>(const_cast<const Student*>(this)->GetScore(midterm));
}
private:
char midtermScore;
char finalScore;
};
int main()
{
// non-const object
Student a;
// We can assign to the reference. Non-const version of GetScore is called
a.GetScore(true) = 'B';
a.GetScore(false) = 'A';
// const object
const Student b(a);
// We still can call GetScore method of const object,
// because we have overloaded const version of GetScore
std::cout << b.GetScore(true) << b.GetScore(false) << '\n';
}
class MyClass
{
private:
int myInt_;
public:
int myInt() const { return myInt_; }
void setMyInt(int myInt) { myInt_ = myInt; }
};
In a const member function, the this pointer is effectively a const MyClass * instead of a MyClass *. This means
that you cannot change any member variables within the function; the compiler will emit a warning. So setMyInt
You should almost always mark member functions as const when possible. Only const member functions can be
called on a const MyClass.
static methods cannot be declared as const. This is because a static method belongs to a class and is not called
on object; therefore it can never modify object's internal variables. So declaring static methods as const would be
redundant.
int f = 0;
e = &f; // OK; e is a non-const pointer-to-const,
// which means that it can be rebound to new int* or const int*
int *g = &f;
*g = 1; // OK; this value still can be changed through dereferencing
// a pointer-not-to-const
pA = &b;
*pB = b;
int a = 0;
good_counter(); // 0
good_counter(); // 1
good_counter(); // 2
If you are thinking about caching a result of expensive computation, you should probably use this keyword.
If you have a lock (for example, std::unique_lock) data field which is locked and unlocked inside a const method,
this keyword is also what you could use.
You should not use this keyword to break logical const-ness of an object.
class pi_calculator {
public:
double get_pi() const {
if (pi_calculated) {
return pi;
} else {
double new_pi = 0;
for (int i = 0; i < 1000000000; ++i) {
// some calculation to refine new_pi
}
// note: if pi and pi_calculated were not mutable, we would get an error from a
compiler
// because in a const method we can not change a non-mutable field
pi = new_pi;
pi_calculated = true;
return pi;
}
}
private:
mutable bool pi_calculated = false;
In a more complex scenario, multiple classes that rely on each others' implementation details may be required.
Friend classes and functions allow these peers access to each others' details, without compromising the
encapsulation and information hiding of the documented interface.
class PrivateHolder {
public:
PrivateHolder(int val) : private_value(val) {}
private:
int private_value;
// Declare one of the function as a friend.
friend void friend_function();
};
void non_friend_function() {
PrivateHolder ph(10);
// Compilation error: private_value is private.
std::cout << ph.private_value << std::endl;
}
void friend_function() {
// OK: friends may access private values.
PrivateHolder ph(10);
std::cout << ph.private_value << std::endl;
}
Access modifiers do not alter friend semantics. Public, protected and private declarations of a friend are equivalent.
void friend_function() {
PrivateHolderDerived pd(20);
// OK.
std::cout << pd.private_value << std::endl;
// Compilation error: derived_private_value is private.
Note that PrivateHolderDerived member function cannot access PrivateHolder::private_value, while friend
function can do it.
class Accesser {
public:
void private_accesser();
};
class PrivateHolder {
public:
PrivateHolder(int val) : private_value(val) {}
friend void Accesser::private_accesser();
private:
int private_value;
};
void Accesser::private_accesser() {
PrivateHolder ph(10);
// OK: this method is declares as friend.
std::cout << ph.private_value << std::endl;
}
class Accesser {
public:
void private_accesser1();
void private_accesser2();
};
class PrivateHolder {
public:
PrivateHolder(int val) : private_value(val) {}
friend class Accesser;
private:
int private_value;
};
void Accesser::private_accesser1() {
PrivateHolder ph(10);
// OK.
std::cout << ph.private_value << std::endl;
}
void Accesser::private_accesser2() {
PrivateHolder ph(10);
// OK.
std::cout << ph.private_value + 1 << std::endl;
Friend class declaration is not reflexive. If classes need private access in both directions, both of them need friend
declarations.
class Accesser {
public:
void private_accesser1();
void private_accesser2();
private:
int private_value = 0;
};
class PrivateHolder {
public:
PrivateHolder(int val) : private_value(val) {}
// Accesser is a friend of PrivateHolder
friend class Accesser;
void reverse_accesse() {
// but PrivateHolder cannot access Accesser's members.
Accesser a;
std::cout << a.private_value;
}
private:
int private_value;
};
class foo {
int x;
public:
int get_x();
void set_x(int new_x);
};
2. Introduces an elaborated type specifier, which specifies that the following name is the name of a class type. If
the class name has been declared already, it can be found even if hidden by another name. If the class name
has not been declared already, it is forward-declared.
4. In the declaration of a template template parameter, the keyword class precedes the name of the
parameter. Since the argument for a template template parameter can only be a class template, the use of
class here is redundant. However, the grammar of C++ requires it.
5. Note that sense 2 and sense 3 may be combined in the same declaration. For example:
foo<class bar> x; // <- bar does not have to have previously appeared.
Version ≥ C++11
enum Direction {
UP,
LEFT,
DOWN,
RIGHT
};
Direction d = UP;
Version ≥ C++11
In C++11, enum may optionally be followed by class or struct to define a scoped enum. Furthermore, both scoped
and unscoped enums can have their underlying type explicitly specified by : T following the enum name, where T
refers to an integer type.
Enumerators in normal enums may also be preceded by the scope operator, although they are still considered to be
in the scope the enum was defined in.
l1 = ENGLISH;
l2 = Language::OTHER;
2. Introduces an elaborated type specifier, which specifies that the following name is the name of a previously
declared enum type. (An elaborated type specifier cannot be used to forward-declare an enum type.) An
Version ≥ C++11
3. Introduces an opaque enum declaration, which declares an enum without defining it. It can either redeclare a
previously declared enum, or forward-declare an enum that has not been previously declared.
An enum first declared as scoped cannot later be declared as unscoped, or vice versa. All declarations of an
enum must agree in underlying type.
When forward-declaring an unscoped enum, the underlying type must be explicitly specified, since it cannot
be inferred until the values of the enumerators are known.
If a class type is defined using the keyword struct, then the default accessibility of bases and members is
public rather than private.
struct cannot be used to declare a template type parameter or template template parameter; only class
can.
2. Introduces an elaborated type specifier, which specifies that the following name is the name of a union type. If
the union name has been declared already, it can be found even if hidden by another name. If the union
name has not been declared already, it is forward-declared.
An unsigned integer type with the same size and alignment as uint_least16_t, which is therefore large enough to
hold a UTF-16 code unit.
An unsigned integer type with the same size and alignment as uint_least32_t, which is therefore large enough to
hold a UTF-32 code unit.
int x = 2;
int y = 3;
int z = x + y;
Can be combined with unsigned, short, long, and long long (q.v.) in order to yield other integer types.
Moreover, a function may redundantly be declared with a single parameter of type void; this is equivalent to
declaring a function with no parameters (e.g. int main() and int main(void) declare the same function). This
syntax is allowed for compatibility with C (where function declarations have a different meaning than in C++).
Any expression may be converted to an expression of type void; this is called a discarded-value expression:
This may be useful to signal explicitly that the value of an expression is not of interest and that the expression is to
be evaluated for its side effects only.
It is normally used when you need to store characters over ASCII 255 , as it has a greater size than the character
type char.
The combination long double denotes a floating point type, which has the widest range out of the three floating
point types.
When the long specifier occurs twice, as in long long, it denotes a signed integer type that is at least as long as
long, and whose range includes at least -9223372036854775807 to +9223372036854775807, inclusive (that is, -
(2^63 - 1) to +(2^63 - 1)).
bool is_even(int x) {
return x%2 == 0;
}
const bool b = is_even(47); // false
If the operand e is a name without any additional parentheses, then decltype(e) is the declared type of e.
int x = 42;
std::vector<decltype(x)> v(100, x); // v is a vector<int>
If the operand e is a class member access without any additional parentheses, then decltype(e) is the
declared type of the member accessed.
struct S {
int x = 42;
};
const S s;
decltype(s.x) y; // y has type int, even though s.x is const
In all other cases, decltype(e) yields both the type and the value category of the expression e, as follows:
Version ≥ C++14
The special form decltype(auto) deduces the type of a variable from its initializer or the return type of a function
from the return statements in its definition, using the type deduction rules of decltype rather than those of auto.
struct S {
void f();
void g() const;
};
const S s;
s.f(); // error
s.g(); // OK
In the example below, if memory_mapped_port were not volatile, the compiler could optimize the function so that it
performs only the final write, which would be incorrect if sizeof(int) is greater than 1. The volatile qualification
forces it to treat all sizeof(int) writes as different side effects and hence perform all of them (in order).
When used alone, int is implied, so that signed, signed int, and int are the same type.
When combined with char, yields the type signed char, which is a different type from char, even if char is
also signed. signed char has a range that includes at least -127 to +127, inclusive.
When combined with short, long, or long long, it is redundant, since those types are already signed.
signed cannot be combined with bool, wchar_t, char16_t, or char32_t.
Example:
When used alone, int is implied, so unsigned is the same type as unsigned int.
The type unsigned char is different from the type char, even if char is unsigned. It can hold integers up to at
least 255.
unsigned can also be combined with short, long, or long long. It cannot be combined with bool, wchar_t,
char16_t, or char32_t.
char invert_case_table[256] = { ..., 'a', 'b', 'c', ..., 'A', 'B', 'C', ... };
char invert_case(char c) {
unsigned char index = c;
return invert_case_table[index];
// note: returning invert_case_table[c] directly does the
// wrong thing on implementations where char is a signed type
}
The asm statement is a definition, not an expression, so it may appear either at block scope or namespace scope
(including global scope). However, since inline assembly cannot be constrained by the rules of the C++ language,
asm may not appear inside a constexpr function.
Example:
void C++
1. When used as a function return type, the void keyword specifies that the function does not return a value.
When used for a function's parameter list, void specifies that the function takes no parameters. When used
in the declaration of a pointer, void specifies that the pointer is "universal."
2. If a pointer's type is void *, the pointer can point to any variable that is not declared with the const or volatile
keyword. A void pointer cannot be dereferenced unless it is cast to another type. A void pointer can be
converted into any other type of data pointer.
3. A void pointer can point to a function, but not to a class member in C++.
Volatile C++
1. A type qualifier that you can use to declare that an object can be modified in the program by the hardware.
volatile declarator ;
Parameters
3. access-specifier Defines the level of access to the base class, public, protected or private. Can appear before
or after the virtual keyword.
this pointer
1. The this pointer is a pointer accessible only within the nonstatic member functions of a class, struct, or union
type. It points to the object for which the member function is called. Static member functions do not have a
this pointer.
this->member-identifier
An object's this pointer is not part of the object itself; it is not reflected in the result of a sizeof statement on the
object. Instead, when a nonstatic member function is called for an object, the address of the object is passed by the
compiler as a hidden argument to the function. For example, the following function call:
myDate.setMonth( 3 );
setMonth( &myDate, 3 );
The object's address is available from within the member function as the this pointer. Most uses of this are implicit.
It is legal, though unnecessary, to explicitly use this when referring to members of the class. For example:
The expression *this is commonly used to return the current object from a member function: return *this; The this
pointer is also used to guard against self-reference:
if (&Object != this) {
// do not execute in cases of self-reference
MyData md;
try {
// Code that could throw an exception
md = GetNetworkResource();
}
catch (const networkIOException& e) {
// Code that executes when an exception of type
// networkIOException is thrown in the try block
// ...
// Log error message in the exception object
cerr << e.what();
}
catch (const myDataFormatException& e) {
// Code that handles another exception type
// ...
cerr << e.what();
}
The code after the try clause is the guarded section of code. The throw expression throws—that is,
raises—an exception. The code block after the catch clause is the exception handler. This is the handler
that catches the exception that's thrown if the types in the throw and catch expressions are compatible.
try {
throw CSomeOtherException();
}
catch(...) {
// Catch all exceptions – dangerous!!!
// Respond (perhaps only partially) to the exception, then
// re-throw to pass the exception to some other handler
// ...
throw;
}
friend (C++)
2. If you declare a friend function that was not previously declared, that function is exported to the enclosing
nonclass scope.
class friend F
friend F;
class ForwardDeclared;// Class name is known.
class HasFriends
{
friend int ForwardDeclared::IsAFriend();// C2039 error expected
};
friend functions
1. A friend function is a function that is not a member of a class but has access to the class's private and
protected members.Friend functions are not considered class members; they are normal external functions
that are given special access privileges.
2. Friends are not in the class's scope, and they are not called using the member-selection operators (. and –>)
unless they are members of another class.
3. A friend function is declared by the class that is granting access. The friend declaration can be placed
anywhere in the class declaration. It is not affected by the access control keywords.
#include <iostream>
private:
int m_i;
};
int main()
{
Point sPoint;
sPoint.PrintPrivate();
ChangePrivate(sPoint);
sPoint.PrintPrivate();
// Output: 0
1
}
class B;
class A {
public:
int Func1( B& b );
private:
int Func2( B& b );
};
class B {
private:
int _b;
2. Introduces a type parameter in the declaration of a template. In this context, it is interchangeable with class.
Version ≥ C++17
3. typename can also be used when declaring a template template parameter, preceding the name of the
parameter, just like class.
class MyVector {
public:
explicit MyVector(uint64_t size);
};
MyVector v1(100); // ok
uint64_t len1 = 100;
MyVector v2{len1}; // ok, len1 is uint64_t
int len2 = 100;
MyVector v3{len2}; // ill-formed, implicit conversion from int to uint64_t
Since C++11 introduced initializer lists, in C++11 and later, explicit can be applied to a constructor with any
number of arguments, with the same meaning as in the single-argument case.
struct S {
explicit S(int x, int y);
};
S f() {
return {12, 34}; // ill-formed
return S{12, 34}; // ok
}
Version ≥ C++11
2. When applied to a conversion function, prevents that conversion function from being used to perform
implicit conversions.
class C {
const int x;
public:
C(int x) : x(x) {}
explicit operator int() { return x; }
};
C c(42);
int x = c; // ill-formed
int y = static_cast<int>(c); // ok; explicit conversion
int a[100];
std::cout << "The number of bytes in `a` is: " << sizeof a;
memset(a, 0, sizeof a); // zeroes out the array
Version ≥ C++11
1. A unary operator that determines whether the evaluation of its operand can propagate an exception. Note
that the bodies of called functions are not examined, so noexcept can yield false negatives. The operand is
not evaluated.
#include <iostream>
#include <stdexcept>
void foo() { throw std::runtime_error("oops"); }
void bar() {}
struct S {};
int main() {
std::cout << noexcept(foo()) << '\n'; // prints 0
std::cout << noexcept(bar()) << '\n'; // prints 0
std::cout << noexcept(1 + 1) << '\n'; // prints 1
std::cout << noexcept(S()) << '\n'; // prints 1
}
In this example, even though bar() can never throw an exception, noexcept(bar()) is still false because the
fact that bar() cannot propagate an exception has not been explicitly specified.
2. When declaring a function, specifies whether or not the function can propagate an exception. Alone, it
declares that the function cannot propagate an exception. With a parenthesized argument, it declares that
the function can or cannot propagate an exception depending on the truth value of the argument.
Version ≥ C++17
Whether or not a function is noexcept is part of the function's type: that is, in the example above, f1, f2, and f3
have different types from f4, f5, and f6. Therefore, noexcept is also significant in function pointers, template
arguments, and so on.
void g1() {}
void g2() noexcept {}
void (*p1)() noexcept = &g1; // ill-formed, since g1 is not noexcept
void (*p2)() noexcept = &g2; // ok; types match
void (*p3)() = &g1; // ok; types match
void (*p4)() = &g2; // ok; implicit conversion
The type std::tuple can bundle any number of values, potentially including values of different types, into a single
return object:
Version ≥ C++17
std::tuple<int, int, int, int> foo(int a, int b) {
return {a + b, a - b, a * b, a / b};
}
Retrieving values from the returned tuple can be cumbersome, requiring the use of the std::get template
function:
If the types can be declared before the function returns, then std::tie can be employed to unpack a tuple into
existing variables:
If you want to return a tuple of lvalue references instead of a tuple of values, use std::tie in place of
std::make_tuple.
which permits
In some rare cases you'll use std::forward_as_tuple instead of std::tie; be careful if you do so, as temporaries
may not last long enough to be consumed.
C++17 introduces structured bindings, which makes it even easier to deal with multiple return types, as you do not
need to rely upon std::tie() or do any manual tuple unpacking:
std::map<std::string, int> m;
if (success) {
// your code goes here
}
// iterate over all elements without having to use the cryptic 'first' and 'second' names
for (auto const& [key, value] : m) {
std::cout << "The value for " << key << " is " << value << '\n';
}
Structured bindings can be used by default with std::pair, std::tuple, and any type whose non-static data
members are all either public direct members or members of an unambiguous base class:
struct A { int x; };
struct B : A { int y; };
B foo();
If you make your type "tuple-like" it will also automatically work with your type. A tuple-like is a type with
appropriate tuple_size, tuple_element and get written:
namespace my_ns {
struct my_type {
int x;
namespace std {
template<>
struct tuple_size<my_ns::my_type_view> : std::integral_constant<std::size_t, 3>
{};
namespace my_ns {
template<std::size_t I>
decltype(auto) get(my_type_view const& v) {
if constexpr (I == 0)
return v.ptr->x;
else if constexpr (I == 1)
return v.ptr->d;
else if constexpr (I == 2)
return v.ptr->s;
static_assert(I < 3, "Only 3 elements");
}
}
my_ns::my_type_view foo() {
return {&t};
}
int main() {
auto[x, d, s] = foo();
std::cout << x << ',' << d << ',' << s << '\n';
}
Version ≥ C++11
struct foo_return_type {
int add;
int sub;
int mul;
int div;
};
Instead of assignment to individual fields, a constructor can be used to simplify the constructing of returned values:
struct foo_return_type {
int add;
int sub;
int mul;
int div;
foo_return_type(int add, int sub, int mul, int div)
: add(add), sub(sub), mul(mul), div(div) {}
};
The individual results returned by the function foo() can be retrieved by accessing the member variables of the
struct calc:
std::cout << calc.add << ' ' << calc.sub << ' ' << calc.mul << ' ' << calc.div << '\n';
Output:
17 -7 60 0
Note: When using a struct, the returned values are grouped together in a single object and accessible using
meaningful names. This also helps to reduce the number of extraneous variables created in the scope of the
returned values.
Version ≥ C++17
In order to unpack a struct returned from a function, structured bindings can be used. This places the out-
parameters on an even footing with the in-parameters:
The output of this code is identical to that above. The struct is still used to return the values from the function.
This permits you do deal with the fields individually.
References:
Pointers:
Some libraries or frameworks use an empty 'OUT' #define to make it abundantly obvious which parameters are
output parameters in the function signature. This has no functional impact, and will be compiled out, but makes the
function signature a bit clearer;
#define OUT
Version ≥ C++11
template <class F>
void foo(int a, int b, F consumer) {
consumer(a + b, a - b, a * b, a / b);
}
You can adapt a function returning a tuple into a continuation passing style function via:
Version ≥ C++17
template<class Tuple>
struct continuation {
Tuple t;
template<class F>
decltype(auto) operator->*(F&& f)&&{
return std::apply( std::forward<F>(f), std::move(t) );
}
};
std::tuple<int,int,int,int> foo(int a, int b);
#include <utility>
std::pair<int, int> foo(int a, int b) {
return std::make_pair(a+b, a-b);
}
Version ≥ C++11
#include <utility>
std::pair<int, int> foo(int a, int b) {
return {a+b, a-b};
}
The individual values of the returned std::pair can be retrieved by using the pair's first and second member
objects:
Output:
10
The container std::array can bundle together a fixed number of return values. This number has to be known at
compile-time and all return values have to be of the same type:
This replaces c style arrays of the form int bar[4]. The advantage being that various c++ std functions can now be
used on it. It also provides useful member functions like at which is a safe member access function with bound
checking, and size which allows you to return the size of the array without calculation.
Example:
Example usage:
std::vector<int> digits;
generate_sequence(0, 10, std::back_inserter(digits));
// digits now contains {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
#include <vector>
#include <iostream>
// the following function returns all integers between and including 'a' and 'b' in a vector
// (the function can return up to std::vector::max_size elements with the vector, given that
// the system's main memory can hold that many items)
std::vector<int> fillVectorFrom(int a, int b) {
std::vector<int> temp;
for (int i = a; i <= b; i++) {
temp.push_back(i);
}
return temp;
}
int main() {
// assigns the filled vector created inside the function to the new vector 'v'
std::vector<int> v = fillVectorFrom(1, 10);
class Shape {
public:
virtual ~Shape() = default;
virtual double get_surface() const = 0;
virtual void describe_object() const { std::cout << "this is a shape" << std::endl; }
You can define polymorphic behavior by introduced member functions with the keyword virtual. Here
get_surface() and describe_object() will obviously be implemented differently for a square than for a
circle. When the function is invoked on an object, function corresponding to the real class of the object will be
determined at runtime.
It makes no sense to define get_surface() for an abstract shape. This is why the function is followed by = 0.
This means that the function is pure virtual function.
You may define non virtual member functions. When these function will be invoked for an object, the
function will be chosen depending on the class used at compile-time. Here get_double_surface() is defined
in this way.
A class that contains at least one pure virtual function is an abstract class. Abstract classes cannot be
instantiated. You may only have pointers or references of an abstract class type.
Derived classes
Once a polymorphic base class is defined you can derive it. For example:
You can define or override any of the virtual functions of the parent class. The fact that a function was virtual
in the parent class makes it virtual in the derived class. No need to tell the compiler the keyword virtual
again. But it's recommended to add the keyword override at the end of the function declaration, in order to
prevent subtle bugs caused by unnoticed variations in the function signature.
If all the pure virtual functions of the parent class are defined you can instantiate objects for this class, else it
will also become an abstract class.
You are not obliged to override all the virtual functions. You can keep the version of the parent if it suits your
need.
Example of instantiation
int main() {
Square square(Point(10.0, 0.0), 6); // we know it's a square, the compiler also
square.describe_object();
std::cout << "Surface: " << square.get_surface() << std::endl;
Shape *ps = nullptr; // we don't know yet the real type of the object
ps = &circle; // it's a circle, but it could as well be a square
ps->describe_object();
std::cout << "Surface: " << ps->get_surface() << std::endl;
}
a downcast would be to cast from a general polymorphic Shape down to one of its derived and more specific shape
like Square or Circle.
Why to downcast ?
Most of the time, you would not need to know which is the real type of the object, as the virtual functions allow you
to manipulate your object independently of its type:
However, you may need sometimes to downcast. A typical example is when you want to invoke a non virtual
function that exist only for the child class.
Consider for example circles. Only circles have a diameter. So the class would be defined as :
class Circle: public Shape { // for Shape, see example on defining a polymorphic class
Point center;
double radius;
public:
The get_diameter() member function only exist for circles. It was not defined for a Shape object:
Shape* ps = get_any_shape();
ps->get_diameter(); // OUCH !!! Compilation error
How to downcast ?
If you'd know for sure that ps points to a circle you could opt for a static_cast:
This will do the trick. But it's very risky: if ps appears to by anything else than a Circle the behavior of your code
will be undefined.
So rather than playing Russian roulette, you should safely use a dynamic_cast. This is specifically for polymorphic
classes :
int main() {
Circle circle(Point(0.0, 0.0), 10);
Shape &shape = circle;
std::cout << "The shape has a surface of " << shape.get_surface() << std::endl;
Note that dynamic_cast is not possible on a class that is not polymorphic. You'd need at least one virtual function in
the class or its parents to be able to use it.
struct VirtualDestructor {
virtual ~VirtualDestructor() = default;
};
// ...
Both of these practices guarantee that the derived class' destructor will always be called on derived class instances,
preventing memory leaks.
int i = 10;
int &refi = i;
// Common pitfall :
// int& refi = i, k = j;
// refi will be of type int&.
// though, k will be of type int, not int&!
References must be initialized correctly at the time of definition, and cannot be modified afterwards. The following
piece of codes causes a compile error:
int i = 5;
int j = i; //Copied
j += 20;
std::cout << i; //Prints 5; i is unaffected by changes to j.
A type is said to have reference semantics if an instance of that type can share its observable state with another
object (external to it), such that manipulating one object will cause the state to change within another object.
C++ pointers have value semantics with regard to which object they point to, but they have reference semantics
with regard to the state of the object they point to:
This kind of copying is called a "deep copy". It effectively takes what would have otherwise been reference
semantics and turns it into value semantics:
Move semantics allow a type like Value to avoid truly copying its referenced data. If the user uses the value in a way
that provokes a move, the "copied" from object can be left empty of the data it referenced:
public:
Value() : array_(new Inner[NUM_INNER]){}
Indeed, we can even make such a type non-copyable, if we want to forbid deep copies while still allowing the object
to be moved around.
public:
Value() : array_(new Inner[NUM_INNER]){}
We can even apply the Rule of Zero, through the use of unique_ptr:
public:
Value() : array_(new Inner[NUM_INNER]){}
In detail the parameters can be seen as variables before the function call and inside the function, where the visible
behaviour and accessibility to these variables differs with the method used to hand them over.
Additionally, the reusability of variables and their respective values after the function call also is explained by this
topic.
When handing over a parameter to a function the value of the used variable (or literal) is copied into the memory
location of the function parameter. This implies that now there a two memory locations with the same value. Inside
of the function we only work on the parameter memory location.
After leaving the function the memory on the program stack is popped (removed) which erases all data of the
function call, including the memory location of the parameters we used inside. Thus, the values changed inside the
function do not affect the outside variables values.
int main(void) {
int a = 0;
int b = 1; //outer_b
int c;
c = func(a,b);
//the return value is copied to c
In this code we create variables inside the main function. These get assigned values. Upon calling the functions
there are two new variables created: f and inner_b where b shares the name with the outer variable it does not
share the memory location. The behaviour of a<->f and b<->b is identical.
The following graphic symbolizes what is happening on the stack and why there is no change in varibale b. The
graphic is not fully accurate but emphazises the example.
// Assignment Operator
#include <iostream>
#include <string>
using std::cout;
using std::endl;
class Foo
{
public:
Foo(int data)
{
this->data = data;
}
~Foo(){};
Foo& operator=(const Foo& rhs)
{
data = rhs.data;
return *this;
}
int data;
};
int main()
{
Foo foo(2); //Foo(int data) called
Foo foo2(42);
foo = foo2; // Assignment Operator Called
cout << foo.data << endl; //Prints 42
}
You can see here I call the assignment operator when I already initialized the foo object. Then later I assign foo2 to
foo . All the changes to appear when you call that equal sign operator is defined in your operator= function. You
can see a runnable output here: http://cpp.sh/3qtbm
// Copy Constructor
#include <iostream>
#include <string>
class Foo
{
public:
Foo(int data)
{
this->data = data;
}
~Foo(){};
Foo(const Foo& rhs)
{
data = rhs.data;
}
int data;
};
int main()
{
Foo foo(2); //Foo(int data) called
Foo foo2 = foo; // Copy Constructor called
cout << foo2.data << endl;
}
You can see here Foo foo2 = foo; in the main function I immediately assign the object before actually initializing it,
which as said before means it's a copy constructor. And notice that I didn't need to pass the parameter int for the
foo2 object since I automatically pulled the previous data from the object foo. Here is an example output :
http://cpp.sh/5iu7
using std::cout;
using std::endl;
class Foo
{
public:
Foo(int data)
{
this->data = data;
}
~Foo(){};
Foo(const Foo& rhs)
{
data = rhs.data;
}
int data;
};
int main()
{
Foo foo(2); //Foo(int data) / Normal Constructor called
Foo foo2 = foo; //Copy Constructor Called
cout << foo2.data << endl;
Foo foo3(42);
foo3=foo; //Assignment Constructor Called
cout << foo3.data << endl;
}
Output:
2
2
Here you can see we first call the copy constructor by executing the line Foo foo2 = foo; . Since we didn't initialize
it previously. And then next we call the assignment operator on foo3 since it was already initialized foo3=foo;
Pointers make use of the "dereference" * , "address of" & , and "arrow" -> operators. The '*' and '->' operators are
used to access the memory being pointed at, and the & operator is used to get an address in memory.
The asterisk (*) is used in declaring a pointer for simple purpose of indicating that it is a pointer. Don't confuse this
with the dereference operator, which is used to obtain the value located at the specified address. They are simply
two different things represented with the same sign.
Note: in all the following, the existence of the C++11 constant nullptr is assumed. For earlier versions, replace
nullptr with NULL, the constant that used to play a similar role.
A pointer variable can be created using the specific * syntax, e.g. int *pointer_to_int;.
When a variable is of a pointer type (int *), it just contains a memory address. The memory address is the location
at which data of the underlying type (int) is stored.
The difference is clear when comparing the size of a variable with the size of a pointer to the same type:
/* Produces:
sizeof(bar) = 24
sizeof(p_bar0) = 8
*/
Pointers can be assigned between each other just as normal variables; in this case, it is the memory address that is
copied from one pointer to another, not the actual data that a pointer points to.
Moreover, they can take the value nullptr which represents a null memory location. A pointer equal to nullptr
contains an invalid memory location and hence it does not refer to valid data.
You can get the memory address of a variable of a given type by prefixing the variable with the address of operator
&. The value returned by & is a pointer to the underlying type which contains the memory address of the variable
(which is valid data as long as the variable does not go out of scope).
p_bar0 = p_bar2;
p_bar2 = nullptr;
// p_bar0 == &bar
// p_bar1 == nullptr
// p_bar2 == nullptr
assigning two pointers does not overwrite the memory that the assigned pointer refers to;
pointers can be null.
the address of operator is required explicitly.
As taking an address requires &, as well accessing the content requires the usage of the dereference operator *, as a
prefix. When a pointer is dereferenced, it becomes a variable of the underlying type (actually, a reference to it). It
can then be read and modified, if not const.
(*p_bar0).foo1 = 5;
// Prints 5 as well
std::cout << "baz.foo1 = " << baz.foo1 << std::endl;
When dereferencing a pointer, you should make sure it points to valid data. Dereferencing an invalid pointer (or a
null pointer) can lead to memory access violation, or to read or write garbage data.
big_struct *never_do_this() {
// This is a local variable. Outside `never_do_this` it doesn't exist.
big_struct retval;
retval.foo1 = 11;
// This returns the address of `retval`.
return &retval;
// `retval` is destroyed and any code using the value returned
// by `never_do_this` has a pointer to a memory location that
// contains garbage data (or is inaccessible).
}
(Clang) warning: address of stack memory associated with local variable 'retval' returned [-
Wreturn-stack-address]
(Gcc) warning: address of local variable ‘retval’ returned [-Wreturn-local-addr]
Hence, care must be taken when pointers are arguments of functions, as they could be null:
// Segmentation fault.
naive_code(nullptr);
A pointer can be incremented or decremented (prefix and postfix). Incrementing a pointer advances the pointer
value to the element in the array one element past the currently pointed to element. Decrementing a pointer
moves it to the previous element in the array.
Pointer arithmetic is not permitted if the type that the pointer points to is not complete. void is always an
If a pointer to the end element is incremented, then the pointer points to one element past the end of the array.
Such a pointer cannot be dereferenced, but it can be decremented.
Incrementing a pointer to the one-past-the-end element in the array, or decrementing a pointer to the first element
in an array yields undefined behavior.
A pointer to a non-array object can be treated, for the purposes of pointer arithmetic, as though it were an array of
size 1.
Addition / Subtraction
Integer values can be added to pointers; they act as incrementing, but by a specific number rather than by 1.
Integer values can be subtracted from pointers as well, acting as pointer decrementing. As with
incrementing/decrementing, the pointer must point to a complete type.
Pointer Differencing
The difference between two pointers to the same type can be computed. The two pointers must be within the same
array object; otherwise undefined behavior results.
Given two pointers P and Q in the same array, if P is the ith element in the array, and Q is the jth element, then P -
Q shall be i - j. The type of the result is std::ptrdiff_t, from <cstddef>.
It is inside a class, so it needs its name decorated with the class name;
It has accessibility, with public, protected or private.
So, if you have access to the static member function and decorate it correctly, then you can point to the function
like any normal function outside a class:
typedef int Fn(int); // Fn is a type-of function that accepts an int and returns an int
class Class {
public:
// Note that Static() is of type 'Fn'
static int Static(int i) { return 3*i; }
}; // Class
int main() {
Fn *fn; // fn is a pointer to a type-of Fn
typedef int Fn(int); // Fn is a type-of function that accepts an int and returns an int
class Class {
public:
// Note that A() is of type 'Fn'
int A(int a) { return 2*a; }
// Note that B() is of type 'Fn'
int B(int b) { return 3*b; }
}; // Class
int main() {
Class c; // Need a Class instance to play with
Class *p = &c; // Need a Class pointer to play with
Unlike pointers to member variables (in the previous example), the association between the class instance and the
member pointer need to be bound tightly together with parentheses, which looks a little strange (as though the .*
and ->* aren't strange enough!)
class Class {
public:
int x, y, z;
char m, n, o;
}; // Class
int main() {
Class c; // Need a Class instance to play with
Class *p = &c; // Need a Class pointer to play with
To define the type of the pointer, you need to mention the base type, as well as the fact that it is inside a
class: int Class::*ptr;.
If you have a class or reference and want to use it with a pointer-to-member, you need to use the .* operator
(akin to the . operator).
If you have a pointer to a class and want to use it with a pointer-to-member, you need to use the ->*
operator (akin to the -> operator).
So, if you have access to the static member variable and decorate it correctly, then you can point to the variable
like any normal variable outside a class:
class Class {
public:
static int i;
}; // Class
int main() {
int k = 3; // Local variable
int *p;
p = &k; // Point to k
*p = 2; // Modify it
p = &j; // Point to j
*p = 3; // Modify it
p = &Class::i; // Point to Class::i
*p = 4; // Modify it
} // main()
struct ThisPointer {
int i;
ThisPointer(int ii);
In a constructor, this can safely be used to (implicitly or explicitly) access any field that has already been initialised,
or any field in a parent class; conversely, (implicitly or explicitly) accessing any fields that haven't yet been initialised,
or any fields in a derived class, is unsafe (due to the derived class not yet being constructed, and thus its fields
neither being initialised nor existing). It is also unsafe to call virtual member functions through this in the
constructor, as any derived class functions will not be considered (due to the derived class not yet being
constructed, and thus its constructor not yet updating the vtable).
class CtorThisBase {
short s;
public:
CtorThisBase() : s(516) {}
};
public:
// Good constructor.
CtorThis() : i(s + 42), j(this->i), k(j) {}
// Bad constructor.
CtorThis(int ii) : i(ii), j(this->k), k(b ? 51 : -51) {
virt_func();
}
public:
CtorThisDerived() : b(true) {}
CtorThisDerived(int ii) : CtorThis(ii), b(false) {}
// ...
CtorThisDerived ctd_good;
CtorThisDerived ctd_bad(3);
using std::cout;
using std::endl;
class Class
{
public:
Class();
~Class();
int getPrivateNumber () const;
private:
int private_number = 42;
};
Class::Class(){}
Class::~Class(){}
int main()
{
Class class_example;
cout << class_example.getPrivateNumber() << endl;
}
using std::cout;
using std::endl;
/*
* @class Dog
* @member name
* Dog's name
* @function bark
Dog::Dog(std::string name)
{
/*
* this->name is the
* name variable from
* the class dog . and
* name is from the
* parameter of the function
*/
this->name = name;
}
Dog::~Dog(){}
int main()
{
Dog dog("Max");
cout << dog.getName() << endl;
dog.bark();
}
this->name = name;
Here , you can see we are assinging the parameter name to the name of the private variable from the class
Dog(this->name) .
struct ThisCVQ {
void no_qualifier() {} // "this" is: ThisCVQ*
void c_qualifier() const {} // "this" is: const ThisCVQ*
void v_qualifier() volatile {} // "this" is: volatile ThisCVQ*
void cv_qualifier() const volatile {} // "this" is: const volatile ThisCVQ*
};
struct CVOverload {
int func() { return 3; }
int func() const { return 33; }
int func() volatile { return 333; }
int func() const volatile { return 3333; }
};
When this is const (including const volatile), the function is unable to write to member variables through it,
whether implicitly or explicitly. The sole exception to this is mutable member variables, which can be written
regardless of const-ness. Due to this, const is used to indicate that the member function doesn't change the
object's logical state (the way the object appears to the outside world), even if it does modify the physical state (the
way the object looks under the hood).
Logical state is the way the object appears to outside observers. It isn't directly tied to physical state, and
indeed, might not even be stored as physical state. As long as outside observers can't see any changes,
the logical state is constant, even if you flip every single bit in the object.
Physical state, also known as bitwise state, is how the object is stored in memory. This is the object's nitty-
gritty, the raw 1s and 0s that make up its data. An object is only physically constant if its representation in
memory never changes.
Note that C++ bases constness on logical state, not physical state.
class DoSomethingComplexAndOrExpensive {
mutable ResultType cached_result;
mutable bool state_changed;
ResultType calculate_result();
void modify_somehow(const Param& p);
// ...
public:
DoSomethingComplexAndOrExpensive(Param p) : state_changed(true) {
modify_somehow(p);
}
void change_state(Param p) {
modify_somehow(p);
state_changed = true;
}
if (state_changed) {
cached_result = calculate_result();
state_changed = false;
}
return cached_result;
}
Note that while you technically could use const_cast on this to make it non-cv-qualified, you really, REALLY
shouldn't, and should use mutable instead. A const_cast is liable to invoke undefined behaviour when used on an
object that actually is const, while mutable is designed to be safe to use. It is, however, possible that you may run
into this in extremely old code.
An exception to this rule is defining non-cv-qualified accessors in terms of const accessors; as the object is
guaranteed to not be const if the non-cv-qualified version is called, there's no risk of UB.
class CVAccessor {
int arr[5];
public:
const int& get_arr_element(size_t i) const { return arr[i]; }
int& get_arr_element(size_t i) {
return const_cast<int&>(const_cast<const CVAccessor*>(this)->get_arr_element(i));
}
};
As with regular pointers, if this is volatile (including const volatile), it is loaded from memory each time it is
accessed, instead of being cached. This has the same effects on optimisation as declaring any other pointer
volatile would, so care should be taken.
Note that if an instance is cv-qualified, the only member functions it is allowed to access are member functions
whose this pointer is at least as cv-qualified as the instance itself:
struct CVAccess {
void func() {}
void func_c() const {}
void func_v() volatile {}
void func_cv() const volatile {}
CVAccess cva;
cva.func(); // Good.
cva.func_c(); // Good.
cva.func_v(); // Good.
cva.func_cv(); // Good.
Similarly to this cv-qualifiers, we can also apply ref-qualifiers to *this. Ref-qualifiers are used to choose between
normal and rvalue reference semantics, allowing the compiler to use either copy or move semantics depending on
which are more appropriate, and are applied to *this instead of this.
Note that despite ref-qualifiers using reference syntax, this itself is still a pointer. Also note that ref-qualifiers don't
actually change the type of *this; it's just easier to describe and understand their effects by looking at them as if
they did.
struct RefQualifiers {
std::string s;
// Normal version.
void func() & { std::cout << "Accessed on normal instance " << s << std::endl; }
// Rvalue version.
void func() && { std::cout << "Accessed on temporary instance " << s << std::endl; }
// ...
RefQualifiers rf("Fred");
rf.func(); // Output: Accessed on normal instance Fred
RefQualifiers{}.func(); // Output: Accessed on temporary instance The nameless one
A member function cannot have overloads both with and without ref-qualifiers; the programmer has to choose
struct RefCV {
void func() & {}
void func() && {}
void func() const& {}
void func() const&& {}
void func() volatile& {}
void func() volatile&& {}
void func() const volatile& {}
void func() const volatile&& {}
};
A std::unique_ptr is a class template that manages the lifetime of a dynamically stored object. Unlike for
std::shared_ptr, the dynamic object is owned by only one instance of a std::unique_ptr at any time,
Only the variable ptr holds a pointer to a dynamically allocated int. When a unique pointer that owns an object
goes out of scope, the owned object is deleted, i.e. its destructor is called if the object is of class type, and the
memory for that object is released.
To use std::unique_ptr and std::make_unique with array-types, use their array specializations:
You can access the std::unique_ptr just like a raw pointer, because it overloads those operators.
You can transfer ownership of the contents of a smart pointer to another pointer by using std::move, which will
cause the original smart pointer to point to nullptr.
// 1. std::unique_ptr
std::unique_ptr<int> ptr = std::make_unique<int>();
// Change value to 1
*ptr = 1;
// 2. std::unique_ptr (by moving 'ptr' to 'ptr2', 'ptr' doesn't own the object anymore)
std::unique_ptr<int> ptr2 = std::move(ptr);
Returning unique_ptr from functions. This is the preferred C++11 way of writing factory functions, as it clearly
conveys the ownership semantics of the return: the caller owns the resulting unique_ptr and is responsible for it.
int* foo_cpp03();
The class template make_unique is provided since C++14. It's easy to add it manually to C++11 code:
Unlike the dumb smart pointer (std::auto_ptr), unique_ptr can also be instantiated with vector allocation (not
std::vector). Earlier examples were for scalar allocations. For example to have a dynamically allocated integer
array for 10 elements, you would specify int[] as the template type (and not just int):
You need not to worry about de-allocation. This template specialized version calls constructors and destructors
appropriately. Using vectored version of unique_ptr or a vector itself - is a personal choice.
In versions prior to C++11, std::auto_ptr was available. Unlike unique_ptr it is allowed to copy auto_ptrs, upon
which the source ptr will lose the ownership of the contained pointer and the target receives it.
To create multiple smart pointers that share the same object, we need to create another shared_ptr that aliases
the first shared pointer. Here are 2 ways of doing it:
Either of the above ways makes secondShared a shared pointer that shares ownership of our instance of Foo with
firstShared.
The smart pointer works just like a raw pointer. This means, you can use * to dereference them. The regular ->
operator works as well:
Finally, when the last aliased shared_ptr goes out of scope, the destructor of our Foo instance is called.
Warning: Constructing a shared_ptr might throw a bad_alloc exception when extra data for shared ownership
semantics needs to be allocated. If the constructor is passed a regular pointer it assumes to own the object pointed
to and calls the deleter if an exception is thrown. This means shared_ptr<T>(new T(args)) will not leak a T object if
allocation of shared_ptr<T> fails. However, it is advisable to use make_shared<T>(args) or
allocate_shared<T>(alloc, args), which enable the implementation to optimize the memory allocation.
Specifying std::default_delete is mandatory here to make sure that the allocated memory is correctly cleaned up
using delete[].
template<class Arr>
struct shared_array_maker {};
template<class T, std::size_t N>
struct shared_array_maker<T[N]> {
std::shared_ptr<T> operator()const{
auto r = std::make_shared<std::array<T,N>>();
if (!r) return {};
return {r.data(), r};
}
Version ≥ C++17
With C++17, shared_ptr gained special support for array types. It is no longer necessary to specify the array-deleter
explicitly, and the shared pointer can be dereferenced using the [] array index operator:
Both p2 and p1 own the object of type Foo, but p2 points to its int member x. This means that if p1 goes out of
scope or is reassigned, the underlying Foo object will still be alive, ensuring that p2 does not dangle.
Important: A shared_ptr only knows about itself and all other shared_ptr that were created with the alias
constructor. It does not know about any other pointers, including all other shared_ptrs created with a reference to
the same Foo instance:
By default, shared_ptr increments the reference count and doesn't transfer the ownership. However, it can be
made to transfer the ownership using std::move:
shared_ptr<int> up = make_shared<int>();
// Transferring the ownership
shared_ptr<int> up2 = move(up);
// At this point, the reference count of up = 0 and the
// ownership of the pointer is solely with up2 with reference count = 1
#include <memory>
#include <vector>
struct TreeNode {
std::weak_ptr<TreeNode> parent;
std::vector< std::shared_ptr<TreeNode> > children;
};
int main() {
// Create a TreeNode to serve as the root/parent.
std::shared_ptr<TreeNode> root(new TreeNode);
// Reset the root shared pointer, destroying the root object, and
// subsequently its child nodes.
root.reset();
}
As child nodes are added to the root node's children, their std::weak_ptr member parent is set to the root node.
The member parent is declared as a weak pointer as opposed to a shared pointer such that the root node's
reference count is not incremented. When the root node is reset at the end of main(), the root is destroyed. Since
the only remaining std::shared_ptr references to the child nodes were contained in the root's collection children,
all child nodes are subsequently destroyed as well.
Due to control block implementation details, shared_ptr allocated memory may not be released until shared_ptr
reference counter and weak_ptr reference counter both reach zero.
#include <memory>
int main()
{
{
std::weak_ptr<int> wk;
{
// std::make_shared is optimized by allocating only once
// while std::shared_ptr<int>(new int(42)) allocates twice.
// Drawback of std::make_shared is that control block is tied to our integer
std::shared_ptr<int> sh = std::make_shared<int>(42);
wk = sh;
// sh memory should be released at this point...
}
// ... but wk is still alive and needs access to control block
}
// now memory is released (sh and wk)
}
Since std::weak_ptr does not keep its referenced object alive, direct data access through a std::weak_ptr is not
possible. Instead it provides a lock() member function that attempts to retrieve a std::shared_ptr to the
referenced object:
Instead, you need to define your own deleter. The examples here use the SDL_Surface structure which should be
freed using the SDL_FreeSurface() function, but they should be adaptable to many other C interfaces.
The deleter must be callable with a pointer argument, and therefore can be e.g. a simple function pointer:
Any other callable object will work, too, for example a class with an operator():
struct SurfaceDeleter {
void operator()(SDL_Surface* surf) {
SDL_FreeSurface(surf);
}
};
This not only provides you with safe, zero overhead (if you use unique_ptr) automatic memory management, you
Note that the deleter is part of the type for unique_ptr, and the implementation can use the empty base
optimization to avoid any change in size for empty custom deleters. So while std::unique_ptr<SDL_Surface,
SurfaceDeleter> and std::unique_ptr<SDL_Surface, void(*)(SDL_Surface*)> solve the same problem in a
similar way, the former type is still only the size of a pointer while the latter type has to hold two pointers: both the
SDL_Surface* and the function pointer! When having free function custom deleters, it is preferable to wrap the
function in an empty type.
In cases where reference counting is important, one could use a shared_ptr instead of an unique_ptr. The
shared_ptr always stores a deleter, this erases the type of the deleter, which might be useful in APIs. The
disadvantages of using shared_ptr over unique_ptr include a higher memory cost for storing the deleter and a
performance cost for maintaining the reference count.
With template auto, we can make it even easier to wrap our custom deleters:
Here, the purpose of auto is to handle all free functions, whether they return void (e.g. SDL_FreeSurface) or not
(e.g. fclose).
NOTE: std::auto_ptr has been deprecated in C++11 and will be removed in C++17. You should only use this if you
are forced to use C++03 or earlier and are willing to be careful. It is recommended to move to unique_ptr in
combination with std::move to replace std::auto_ptr behavior.
Before we had std::unique_ptr, before we had move semantics, we had std::auto_ptr. std::auto_ptr provides
unique ownership but transfers ownership upon copy.
As with all smart pointers, std::auto_ptr automatically cleans up resources (see RAII):
std::auto_ptr<X> px = ...;
std::auto_ptr<X> py = px;
// px is now empty
This allows to use std::auto_ptr to keep ownership explicit and unique at the danger of losing ownership
unintended:
void f(std::auto_ptr<X> ) {
// assumes ownership of X
// deletes it at end of scope
};
std::auto_ptr<X> px = ...;
f(px); // f acquires ownership of underlying X
// px is now empty
px->foo(); // NPE!
// px.~auto_ptr() does NOT delete
The transfer of ownership happened in the "copy" constructor. auto_ptr's copy constructor and copy assignment
operator take their operands by non-const reference so that they could be modified. An example implementation
might be:
T* release() {
T* tmp = ptr;
ptr = nullptr;
return tmp;
}
This breaks copy semantics, which require that copying an object leaves you with two equivalent versions of it. For
T a = ...;
T b(a);
assert(b == a);
But for auto_ptr, this is not the case. As a result, it is not safe to put auto_ptrs in containers.
Note that std::reinterpret_pointer_cast is not available in C++11 and C++14, as it was only proposed by N3920
and adopted into Library Fundamentals TS in February 2014. However, it can be implemented as follows:
// Like std::default_delete:
template<class T>
struct default_copier {
// a copier must handle a null T const* in and return null:
T* operator()(T const* tin)const {
if (!tin) return nullptr;
return new T(*tin);
}
void operator()(void* dest, T const* tin)const {
if (!tin) return;
return new(dest) T(*tin);
}
};
// tag class to handle empty case:
struct empty_ptr_t {};
constexpr empty_ptr_t empty_ptr{};
// the value pointer type itself:
template<class T, class Copier=default_copier<T>, class Deleter=std::default_delete<T>,
class Base=std::unique_ptr<T, Deleter>
>
struct value_ptr:Base, private Copier {
using Base::Base;
value_ptr( T const& t ):
Base( std::make_unique<T>(t) ),
Copier()
{}
value_ptr( T && t ):
Base( std::make_unique<T>(std::move(t)) ),
Copier()
{}
// almost-never-empty:
value_ptr():
Base( std::make_unique<T>() ),
Copier()
{}
value_ptr( empty_ptr_t ) {}
This particular value_ptr is only empty if you construct it with empty_ptr_t or if you move from it. It exposes the fact
it is a unique_ptr, so explicit operator bool() const works on it. .get() has been changed to return a
reference (as it is almost never empty), and .get_pointer() returns a pointer instead.
This smart pointer can be useful for pImpl cases, where we want value-semantics but we also don't want to expose
the contents of the pImpl outside of the implementation file.
With a non-default Copier, it can even handle virtual base classes that know how to produce instances of their
derived and turn them into value-types.
By deriving your class from the class template enable_shared_from_this, you inherit a method shared_from_this
that returns a shared_ptr instance to this.
#include <memory>
class A: public enable_shared_from_this<A> {
};
A* ap1 =new A();
shared_ptr<A> ap2(ap1); // First prepare a shared pointer to the object and hold it!
// Then get a shared pointer to the object from the object itself
shared_ptr<A> ap3 = ap1->shared_from_this();
int c3 =ap3.use_count(); // =2: pointing to the same object
int main()
{
...
auto w = std::make_shared< Widget >();
w -> DoSomething();
...
}
If you use shared_from_this() on an object not owned by a shared_ptr, such as a local automatic object or a
global object, then the behavior is undefined. Since C++17 it throws std::bad_alloc instead.
Using shared_from_this() from a constructor is equivalent to using it on an object not owned by a shared_ptr,
because the objects is possessed by the shared_ptr after the constructor returns.
The class and struct keywords, called class keys, are largely interchangeable, except that the default access
specifier for members and bases is "private" for a class declared with the class key and "public" for a class declared
with the struct or union key (cf. Access modifiers).
struct Vector
{
int x;
int y;
int z;
};
// are equivalent to
class Vector
{
public:
int x;
int y;
int z;
};
By declaring a class` a new type is added to your program, and it is possible to instantiate objects of that class by
Vector my_vector;
my_vector.x = 10;
my_vector.y = my_vector.x + 1; // my_vector.y = 11;
my_vector.z = my_vector.y - 4; // my:vector.z = 7;
Deriving a class may be forbidden with final specifier. Let's declare a final class:
class A final {
};
class A {
};
// OK.
class B final : public A {
};
Keyword Description
public Everyone has access
protected Only the class itself, derived classes and friends have access
private Only the class itself and friends have access
When the type is defined using the class keyword, the default access specifier is private, but if the type is defined
using the struct keyword, the default access specifier is public:
MyStruct s;
s.x = 9; // well formed, because x is public
MyClass c;
c.x = 9; // ill-formed, because x is private
Access specifiers are mostly used to limit access to internal fields and methods, and force the programmer to use a
specific interface, for example to force use of getters and setters instead of referencing a variable directly:
class MyClass {
public: /* Methods: */
private: /* Fields: */
int m_x;
};
Using protected is useful for allowing certain functionality of the type to be only accessible to the derived classes,
for example, in the following code, the method calculateValue() is only accessible to classes deriving from the
struct Plus2Base {
int value() noexcept { return calculateValue() + 2; }
protected: /* Methods: */
virtual int calculateValue() noexcept = 0;
};
struct FortyTwo: Plus2Base {
protected: /* Methods: */
int calculateValue() noexcept final override { return 40; }
};
Note that the friend keyword can be used to add access exceptions to functions or types for accessing protected
and private members.
The public, protected, and private keywords can also be used to grant or limit access to base class subobjects.
See the Inheritance example.
If a class/struct B inherits from a class/struct A, this means that B has as a parent A. We say that B is a derived
class/struct from A, and A is the base class/struct.
struct A
{
public:
int p1;
protected:
int p2;
private:
int p3;
};
public
private
protected
Note that the default inheritance is the same as the default visibility of members: public if you use the struct
keyword, and private for the class keyword.
It's even possible to have a class derive from a struct (or vice versa). In this case, the default inheritance is
controlled by the child, so a struct that derives from a class will default to public inheritance, and a class that
derives from a struct will have private inheritance by default.
public inheritance:
B b;
b.p1 = 1; //well formed, p1 is public
b.p2 = 1; //ill formed, p2 is protected
b.p3 = 1; //ill formed, p3 is inaccessible
private inheritance:
struct B : private A
{
void foo()
{
p1 = 0; //well formed, p1 is private in B
p2 = 0; //well formed, p2 is private in B
p3 = 0; //ill formed, p3 is private in A
}
};
B b;
b.p1 = 1; //ill formed, p1 is private
b.p2 = 1; //ill formed, p2 is private
b.p3 = 1; //ill formed, p3 is inaccessible
protected inheritance:
struct B : protected A
{
void foo()
{
p1 = 0; //well formed, p1 is protected in B
p2 = 0; //well formed, p2 is protected in B
p3 = 0; //ill formed, p3 is private in A
}
};
B b;
b.p1 = 1; //ill formed, p1 is protected
b.p2 = 1; //ill formed, p2 is protected
b.p3 = 1; //ill formed, p3 is inaccessible
Note that although protected inheritance is allowed, the actual use of it is rare. One instance of how protected
inheritance is used in application is in partial base class specialization (usually referred to as "controlled
polymorphism").
When OOP was relatively new, (public) inheritance was frequently said to model an "IS-A" relationship. That is,
public inheritance is correct only if an instance of the derived class is also an instance of the base class.
This was later refined into the Liskov Substitution Principle: public inheritance should only be used when/if an
instance of the derived class can be substituted for an instance of the base class under any possible circumstance
(and still make sense).
Private inheritance is typically said to embody a completely different relationship: "is implemented in terms of"
Protected inheritance is almost never used, and there's no general agreement on what sort of relationship it
embodies.
class Animal{
private:
double weight;
double height;
public:
friend void printWeight(Animal animal);
friend class AnimalPrinter;
// A common use for a friend function is to overload the operator<< for streaming.
friend std::ostream& operator<<(std::ostream& os, Animal animal);
};
class AnimalPrinter
{
public:
void print(const Animal& animal)
{
// Because of the `friend class AnimalPrinter;" declaration, we are
// allowed to access private members here.
std::cout << animal.weight << ", " << animal.height << std::endl;
}
}
int main() {
Animal animal = {10, 5};
printWeight(animal);
AnimalPrinter aPrinter;
aPrinter.print(animal);
10
10, 5
Animal height: 5
struct A{};
struct B: public virtual A{};
When class B has virtual base A it means that A will reside in most derived class of inheritance tree, and thus that
most derived class is also responsible for initializing that virtual base:
struct A
{
int member;
A(int param)
{
member = param;
}
};
struct B: virtual A
{
B(): A(5){}
};
struct C: B
{
C(): /*A(88)*/ {}
};
void f()
{
C object; //error since C is not initializing it's indirect virtual base `A`
}
If we un-comment /*A(88)*/ we won't get any error since C is now initializing it's indirect virtual base A.
Also note that when we're creating variable object, most derived class is C, so C is responsible for creating(calling
constructor of) A and thus value of A::member is 88, not 5 (as it would be if we were creating object of type B).
A A A
/ \ | |
B C B C
\ / \ /
D D
virtual inheritance normal inheritance
B and C both inherit from A, and D inherits from B and C, so there are 2 instances of A in D! This results in ambiguity
when you're accessing member of A through D, as the compiler has no way of knowing from which class do you
want to access that member (the one which B inherits, or the one that is inherited byC?).
Virtual inheritance solves this problem: Since virtual base resides only in most derived object, there will be only one
instance of A in D.
struct A
{
void foo() {}
class A {
public:
int move();
int turn();
};
class B : private A {
public:
using A::turn;
};
B b;
b.move(); // compile error
b.turn(); // OK
This approach efficiently prevents an access to the A public methods by casting to the A pointer or reference:
B b;
A& a = static_cast<A&>(b); // compile error
In the case of public inheritance such casting will provide access to all the A public methods despite on alternative
ways to prevent this in derived B, like hiding:
class B : public A {
private:
int move();
};
or private using:
class B : public A {
private:
using A::move;
};
B b;
struct SomeStruct {
int a;
int b;
void foo() {}
};
SomeStruct var;
// Accessing member variable a in var.
std::cout << var.a << std::endl;
// Assigning member variable b in var.
var.b = 1;
// Calling a member function.
var.foo();
When accessing the members of a class via a pointer, the -> operator is commonly used. Alternatively, the instance
can be dereferenced and the . operator used, although this is less common:
struct SomeStruct {
int a;
int b;
void foo() {}
};
SomeStruct var;
SomeStruct *p = &var;
// Accessing member variable a in var via pointer.
std::cout << p->a << std::endl;
std::cout << (*p).a << std::endl;
// Assigning member variable b in var via pointer.
p->b = 1;
(*p).b = 1;
// Calling a member function via a pointer.
p->foo();
(*p).foo();
When accessing static class members, the :: operator is used, but on the name of the class instead of an instance
of it. Alternatively, the static member can be accessed from an instance or a pointer to an instance using the . or ->
operator, respectively, with the same syntax as accessing non-static members.
struct SomeStruct {
int a;
int b;
void foo() {}
static int c;
static void bar() {}
};
int SomeStruct::c;
SomeStruct var;
SomeStruct* p = &var;
// Assigning static member variable c in struct SomeStruct.
Background
The -> operator is needed because the member access operator . has precedence over the dereferencing operator
*.
One would expect that *p.a would dereference p (resulting in a reference to the object p is pointing to) and then
accessing its member a. But in fact, it tries to access the member a of p and then dereference it. I.e. *p.a is
equivalent to *(p.a). In the example above, this would result in a compiler error because of two facts: First, p is a
pointer and does not have a member a. Second, a is an integer and, thus, can't be dereferenced.
The uncommonly used solution to this problem would be to explicitly control the precedence: (*p).a
Instead, the -> operator is almost always used. It is a short-hand for first dereferencing the pointer and then
accessing it. I.e. (*p).a is exactly the same as p->a.
The :: operator is the scope operator, used in the same manner as accessing a member of a namespace. This is
because a static class member is considered to be in that class' scope, but isn't considered a member of instances
of that class. The use of normal . and -> is also allowed for static members, despite them not being instance
members, for historical reasons; this is of use for writing generic code in templates, as the caller doesn't need to be
concerned with whether a given member function is static or non-static.
struct IHaveATypedef {
typedef int MyTypedef;
};
struct IHaveATemplateTypedef {
template<typename T>
using MyTemplateTypedef = std::vector<T>;
};
Like static members, these typedefs are accessed using the scope operator, ::.
IHaveATypedef::MyTypedef i = 5; // i is an int.
IHaveATemplateTypedef::MyTemplateTypedef<int> v; // v is a std::vector<int>.
As with normal type aliases, each member type alias is allowed to refer to any type defined or aliased before, but
not after, its definition. Likewise, a typedef outside the class definition can refer to any accessible typedefs within
the class definition, provided it comes after the class definition.
template<typename T>
struct Helper {
T get() const { return static_cast<T>(42); }
struct IHaveTypedefs {
// typedef MyTypedef NonLinearTypedef; // Error if uncommented.
typedef int MyTypedef;
typedef Helper<MyTypedef> MyTypedefHelper;
};
Member type aliases can be declared with any access level, and will respect the appropriate access modifier.
class TypedefAccessLevels {
typedef int PrvInt;
protected:
typedef int ProInt;
public:
typedef int PubInt;
};
This can be used to provide a level of abstraction, allowing a class' designer to change its internal workings without
breaking code that relies on it.
class Something {
friend class SomeComplexType;
short s;
// ...
public:
typedef SomeComplexType MyHelper;
// ...
};
// ...
Something s;
Something::MyHelper hlp = s.get_helper();
In this situation, if the helper class is changed from SomeComplexType to some other type, only the typedef and the
friend declaration would need to be modified; as long as the helper class provides the same functionality, any code
class SomethingElse {
AnotherComplexType<bool, int, SomeThirdClass> helper;
public:
typedef decltype(helper) MyHelper;
private:
InternalVariable<MyHelper> ivh;
// ...
public:
MyHelper& get_helper() const { return helper; }
// ...
};
In this situation, changing the implementation of SomethingElse::helper will automatically change the typedef for
us, due to decltype. This minimises the number of modifications necessary when we want to change helper, which
minimises the risk of human error.
As with everything, however, this can be taken too far. If the typename is only used once or twice internally and
zero times externally, for example, there's no need to provide an alias for it. If it's used hundreds or thousands of
times throughout a project, or if it has a long enough name, then it can be useful to provide it as a typedef instead
of always using it in absolute terms. One must balance forwards compatibility and convenience with the amount of
unnecessary noise created.
This can also be used with template classes, to provide access to the template parameters from outside the class.
template<typename T>
class SomeClass {
// ...
public:
typedef T MyParam;
MyParam getParam() { return static_cast<T>(42); }
};
template<typename T>
typename T::MyParam some_func(T& t) {
return t.getParam();
}
SomeClass<int> si;
int i = some_func(si);
This is commonly used with containers, which will usually provide their element type, and other helper types, as
member type aliases. Most of the containers in the C++ standard library, for example, provide the following 12
helper types, along with any other special types they might need.
template<typename T>
class SomeContainer {
public:
// Let's provide the same helper types as most standard containers.
typedef T value_type;
typedef std::allocator<value_type> allocator_type;
typedef value_type& reference;
typedef const value_type& const_reference;
typedef value_type* pointer;
typedef const value_type* const_pointer;
typedef MyIterator<value_type> iterator;
typedef MyConstIterator<value_type> const_iterator;
typedef std::reverse_iterator<iterator> reverse_iterator;
typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
typedef size_t size_type;
typedef ptrdiff_t difference_type;
};
Prior to C++11, it was also commonly used to provide a "template typedef" of sorts, as the feature wasn't yet
available; these have become a bit less common with the introduction of alias templates, but are still useful in some
situations (and are combined with alias templates in other situations, which can be very useful for obtaining
individual components of a complex type such as a function pointer). They commonly use the name type for their
type alias.
template<typename T>
struct TemplateTypedef {
typedef T type;
}
TemplateTypedef<int>::type i; // i is an int.
This was often used with types with multiple template parameters, to provide an alias that defines one or more of
the parameters.
template<typename T>
struct MonoDisplayLine {
typedef Array<T, 80, 1> type;
};
struct Outer {
struct Inner { };
};
From outside of the enclosing class, nested classes are accessed using the scope operator. From inside the
enclosing class, however, nested classes can be used without qualifiers:
struct Outer {
struct Inner { };
Inner in;
};
// ...
Outer o;
Outer::Inner i = o.in;
As with a non-nested class/struct, member functions and static variables can be defined either within a nested
class, or in the enclosing namespace. However, they cannot be defined within the enclosing class, due to it being
considered to be a different class than the nested class.
// Bad.
struct Outer {
struct Inner {
void do_something();
};
void Inner::do_something() {}
};
// Good.
struct Outer {
struct Inner {
void do_something();
};
};
void Outer::Inner::do_something() {}
As with non-nested classes, nested classes can be forward declared and defined later, provided they are defined
before being used directly.
class Outer {
class Inner1;
class Inner2;
Inner1 in1;
Inner2* in2p;
public:
Outer();
Prior to C++11, nested classes only had access to type names, static members, and enumerators from the
enclosing class; all other members defined in the enclosing class were off-limits.
Version ≥ C++11
As of C++11, nested classes, and members thereof, are treated as if they were friends of the enclosing class, and
can access all of its members, according to the usual access rules; if members of the nested class require the ability
to evaluate one or more non-static members of the enclosing class, they must therefore be passed an instance:
class Outer {
struct Inner {
int get_sizeof_x() {
return sizeof(x); // Legal (C++11): x is unevaluated, so no instance is required.
}
int get_x() {
return x; // Illegal: Can't access non-static member without an instance.
}
int get_x(Outer& o) {
return o.x; // Legal (C++11): As a member of Outer, Inner can access private members.
}
};
int x;
};
Conversely, the enclosing class is not treated as a friend of the nested class, and thus cannot access its private
members without explicitly being granted permission.
class Outer {
class Inner {
// friend class Outer;
int x;
};
Inner in;
public:
int get_x() {
return in.x; // Error: int Outer::Inner::x is private.
// Uncomment "friend" line above to fix.
}
};
Friends of a nested class are not automatically considered friends of the enclosing class; if they need to be friends
of the enclosing class as well, this must be declared separately. Conversely, as the enclosing class is not
class Outer {
friend void barge_out(Outer& out, Inner& in);
class Inner {
friend void barge_in(Outer& out, Inner& in);
int i;
};
int o;
};
As with all other class members, nested classes can only be named from outside the class if they have public
access. However, you are allowed to access them regardless of access modifier, as long as you don't explicitly name
them.
class Outer {
struct Inner {
void func() { std::cout << "I have no private taboo.\n"; }
};
public:
static Inner make_Inner() { return Inner(); }
};
// ...
You can also create a type alias for a nested class. If a type alias is contained in the enclosing class, the nested type
and the type alias can have different access modifiers. If the type alias is outside the enclosing class, it requires that
either the nested class, or a typedef thereof, be public.
class Outer {
class Inner_ {};
public:
typedef Inner_ Inner;
};
As with other classes, nested classes can both derive from or be derived from by other classes.
struct Outer {
struct Inner : Base {};
};
This can be useful in situations where the enclosing class is derived from by another class, by allowing the
programmer to update the nested class as necessary. This can be combined with a typedef to provide a consistent
name for each enclosing class' nested class:
class BaseOuter {
struct BaseInner_ {
virtual void do_something() {}
virtual void do_something_else();
} b_in;
public:
typedef BaseInner_ Inner;
void BaseOuter::BaseInner_::do_something_else() {}
// ---
public:
typedef DerivedInner_ Inner;
void DerivedOuter::DerivedInner_::do_something_else() {}
// ...
// Calls BaseOuter::BaseInner_::do_something();
BaseOuter* b = new BaseOuter;
BaseOuter::Inner& bin = b->getInner();
bin.do_something();
b->getInner().do_something();
In the above case, both BaseOuter and DerivedOuter supply the member type Inner, as BaseInner_ and
DerivedInner_, respectively. This allows nested types to be derived without breaking the enclosing class' interface,
and allows the nested type to be used polymorphically.
void foo()
{
struct /* No name */ {
float x;
float y;
} point;
point.x = 42;
}
or
struct Circle
{
struct /* No name */ {
float x;
float y;
} center; // but a member name
float radius;
};
and later
Circle circle;
circle.center.x = 42.f;
struct InvalidCircle
{
struct /* No name */ {
float centerX;
float centerY;
}; // No member either.
float radius;
};
Version ≥ C++11
void print_square_coordinates()
{
const struct {float x; float y;} points[] = {
{-1, -1}, {-1, 1}, {1, -1}, {1, 1}
};
class Example {
static int num_instances; // Static data member (static member variable).
int i; // Non-static member variable.
public:
static std::string static_str; // Static data member (static member variable).
static int static_func(); // Static member function.
int Example::num_instances;
std::string Example::static_str = "Hello.";
// ...
Static member variables are not considered to be defined inside the class, only declared, and thus have their
class Example {
static int num_instances; // Declaration.
public:
static std::string static_str; // Declaration.
// ...
};
Due to this, static variables can be incomplete types (apart from void), as long as they're later defined as a
complete type.
struct ForwardDeclared;
class ExIncomplete {
static ForwardDeclared fd;
static ExIncomplete i_contain_myself;
static int an_array[];
};
ForwardDeclared ExIncomplete::fd;
ExIncomplete ExIncomplete::i_contain_myself;
int ExIncomplete::an_array[5];
Static member functions can be defined inside or outside the class definition, as with normal member functions. As
with static member variables, the keyword static is omitted when defining static member functions outside the
class definition.
public:
static int static_func() { return num_instances; }
// ...
// Or...
If a static member variable is declared const but not volatile, and is of an integral or enumeration type, it can be
initialised at declaration, inside the class definition.
enum E { VAL = 5 };
As of C++11, static member variables of LiteralType types (types that can be constructed at compile time,
according to constexpr rules) can also be declared as constexpr; if so, they must be initialised within the class
definition.
struct ExConstexpr {
constexpr static int ci = 5; // Good.
static constexpr double cd = 5; // Good.
constexpr static int carr[] = { 1, 1, 2 }; // Good.
static constexpr ConstexprConstructibleClass c{}; // Good.
constexpr static int bad_ci; // Error.
};
If a const or constexpr static member variable is odr-used (informally, if it has its address taken or is assigned to a
reference), then it must still have a separate definition, outside the class definition. This definition is not allowed to
contain an initialiser.
struct ExODR {
static const int odr_used = 5;
};
const int* odr_user = & ExODR::odr_used; // Error; uncomment above line to resolve.
As static members aren't tied to a given instance, they can be accessed using the scope operator, ::.
They can also be accessed as if they were normal, non-static members. This is of historical significance, but is used
less commonly than the scope operator to prevent confusion over whether a member is static or non-static.
Example ex;
std::string rts = ex.static_str;
Class members are able to access static members without qualifying their scope, as with non-static class members.
class ExTwo {
static int num_instances;
int my_num;
public:
ExTwo() : my_num(num_instances++) {}
int ExTwo::num_instances;
They cannot be mutable, nor would they need to be; as they aren't tied to any given instance, whether an instance
is or isn't const doesn't affect static members.
struct ExDontNeedMutable {
int immuta;
mutable int muta;
static int i;
// ...
class ExAccess {
static int prv_int;
protected:
static int pro_int;
public:
static int pub_int;
};
int ExAccess::prv_int;
int ExAccess::pro_int;
int ExAccess::pub_int;
// ...
As they aren't tied to a given instance, static member functions have no this pointer; due to this, they can't access
non-static member variables unless passed an instance.
class ExInstanceRequired {
int i;
public:
ExInstanceRequired() : i(0) {}
Due to not having a this pointer, their addresses can't be stored in pointers-to-member-functions, and are instead
stored in normal pointers-to-functions.
struct ExPointer {
void nsfunc() {}
static void sfunc() {}
};
Due to not having a this pointer, they also cannot be const or volatile, nor can they have ref-qualifiers. They also
cannot be virtual.
struct ExCVQualifiersAndVirtual {
static void func() {} // Good.
static void cfunc() const {} // Error.
static void vfunc() volatile {} // Error.
static void cvfunc() const volatile {} // Error.
static void rfunc() & {} // Error.
static void rvfunc() && {} // Error.
As they aren't tied to a given instance, static member variables are effectively treated as special global variables;
they're created when the program starts, and destroyed when it exits, regardless of whether any instances of the
class actually exist. Only a single copy of each static member variable exists (unless the variable is declared
thread_local (C++11 or later), in which case there's one copy per thread).
Static member variables have the same linkage as the class, whether the class has external or internal linkage. Local
classes and unnamed classes aren't allowed to have static members.
class A {};
class B : public A {};
class A {};
class B {};
class C : public A, public B {};
Note: this can lead to ambiguity if the same names are used in multiple inherited classs or structs. Be careful!
For example: Two base classes have functions with same name which is not overridden in derived class and if you
write code to access that function using object of derived class, compiler shows error because, it cannot determine
which function to call. Here is a code for this type of ambiguity in multiple inheritance.
class base1
{
public:
void funtion( )
{ //code for base1 function }
};
class base2
{
void function( )
{ // code for base2 function }
};
};
int main()
{
derived obj;
But, this problem can be solved using scope resolution function to specify which function to class either base1 or
base2:
int main()
{
obj.base1::function( ); // Function of class base1 is called.
obj.base2::function( ); // Function of class base2 is called.
}
class CL {
public:
void member_function() {}
};
CL instance;
instance.member_function();
They can be defined either inside or outside the class definition; if defined outside, they are specified as being in
struct ST {
void defined_inside() {}
void defined_outside();
};
void ST::defined_outside() {}
They can be CV-qualified and/or ref-qualified, affecting how they see the instance they're called upon; the function
will see the instance as having the specified cv-qualifier(s), if any. Which version is called will be based on the
instance's cv-qualifiers. If there is no version with the same cv-qualifiers as the instance, then a more-cv-qualified
version will be called if available.
struct CVQualifiers {
void func() {} // 1: Instance is non-cv-qualified.
void func() const {} // 2: Instance is const.
CVQualifiers non_cv_instance;
const CVQualifiers c_instance;
Member function ref-qualifiers indicate whether or not the function is intended to be called on rvalue instances,
and use the same syntax as function cv-qualifiers.
struct RefQualifiers {
void func() & {} // 1: Called on normal instances.
void func() && {} // 2: Called on rvalue (temporary) instances.
};
RefQualifiers rf;
rf.func(); // Calls #1.
RefQualifiers{}.func(); // Calls #2.
struct BothCVAndRef {
void func() const& {} // Called on normal instances. Sees instance as const.
void func() && {} // Called on temporary instances.
};
They can also be virtual; this is fundamental to polymorphism, and allows a child class(es) to provide the same
interface as the parent class, while supplying their own functionality.
struct Base {
virtual void func() {}
};
struct Derived {
virtual void func() {}
};
Suppose you are writing a series of functions for generalized printing capabilities, beginning with std::string:
This works fine, but suppose you want a function that also accepts an int and prints that too. You could write:
But because the two functions accept different parameters, you can simply write:
Now you have 2 functions, both named print, but with different signatures. One accepts std::string, the other
one an int. Now you can call them without worrying about different names:
Instead of:
print("Hello world!");
print_int(1337);
When you have overloaded functions, the compiler infers which of the functions to call from the parameters you
provide it. Care must be taken when writing function overloads. For example, with implicit type conversions:
Now it's not immediately clear which overload of print is called when you write:
And you might need to give your compiler some clues, like:
print(static_cast<double>(5));
print(static_cast<int>(5));
print(5.0);
Some care also needs to be taken when writing overloads that accept optional parameters:
// WRONG CODE
void print(int num1, int num2 = 0) //num2 defaults to 0 if not included
{
std::cout << "These are ints: << num1 << " and " << num2 << std::endl;
}
void print(int num)
{
std::cout << "This is an int: " << num << std::endl;
}
Because there's no way for the compiler to tell if a call like print(17) is meant for the first or second function
because of the optional second parameter, this will fail to compile.
// WRONG CODE
std::string getValue()
{
return "hello";
}
int getValue()
{
return 0;
}
int x = getValue();
This will cause a compilation error as the compiler will not be able to work out which version of getValue to call,
even though the return type is assigned to an int.
This is necessary because a member function can only be called if it is at least as cv-qualified as the instance it's
called on. While a non-const instance can call both const and non-const members, a const instance can only call
const members. This allows a function to have different behaviour depending on the calling instance's cv-qualifiers,
and allows the programmer to disallow functions for an undesired cv-qualifier(s) by not providing a version with
that qualifier(s).
#include <iostream>
class Integer
{
public:
Integer(int i_): i{i_}{}
void print()
{
std::cout << "int: " << i << std::endl;
}
protected:
int i;
};
int main()
{
Integer i{5};
const Integer &ic = i;
This is a key tenet of const correctness: By marking member functions as const, they are allowed to be called on
const instances, which in turn allows functions to take instances as const pointers/references if they don't need to
modify them. This allows code to specify whether it modifies state by taking unmodified parameters as const and
modified parameters without cv-qualifiers, making code both safer and more readable.
class ConstCorrect
{
public:
void good_func() const
{
std::cout << "I care not whether the instance is const." << std::endl;
}
void bad_func()
{
std::cout << "I can only be called on non-const, non-volatile instances." << std::endl;
}
};
No class members can be modified within a const member function. If there is some member that you really need
to modify, such as locking a std::mutex, you can declare it as mutable:
class Integer
{
public:
Integer(int i_): i{i_}{}
protected:
int i;
mutable std::mutex mut;
};
+ and +=
- and -=
* and *=
/ and /=
& and &=
| and |=
^ and ^=
>> and >>=
<< and <<=
Overloading for all operators is the same. Scroll down for explanation
Note: operator+ should return by non-const value, as returning a reference wouldn't make sense (it returns a new
object) nor would returning a const value (you should generally not return by const). The first argument is passed
by value, why? Because
Passing by const& would be an option, but then you will have to make a temporary copy of the passed object. By
passing by value, the compiler does it for you.
operator+= returns a reference to the itself, because it is then possible to chain them (don't use the same variable
though, that would be undefined behavior due to sequence points).
The first argument is a reference (we want to modify it), but not const, because then you wouldn't be able to
modify it. The second argument should not be modified, and so for performance reason is passed by const&
(passing by const reference is faster than by value).
You should always (99.98% of the time) implement 2 versions, a const and a not-const version, because if the
object is const, it should not be able to modify the object returned by [].
The arguments are passed by const& instead of by value because passing by reference is faster than by value, and
const so that the operator doesn't change the index accidentally.
The operators return by reference, because by design you can modify the object [] return, i.e:
std::vector<int> v{ 1 };
v[0] = 2; //Changes value of 1 to 2
//wouldn't be possible if not returned by reference
Multiple subscript operators, [][]..., can be achieved via proxy objects. The following example of a simple row-
major matrix class demonstrates this:
template<class T>
class matrix {
// class enabling [][] overload to access matrix elements
template <class C>
class proxy_row_vector {
using reference = decltype(std::declval<C>()[0]);
using const_reference = decltype(std::declval<C const>()[0]);
Example:
struct Text
{
std::string text;
Text t;
t.text = "Hello world!";
This is intended to be a holistic example covering operator overloading alongside basic use of templates.
#include <type_traits>
namespace not_std{
using std::decay_t;
//----------------------------------------------------------------
// complex< value_t >
//----------------------------------------------------------------
template<typename value_t>
struct complex
{
value_t x;
value_t y;
template<typename other_value_t>
explicit complex(const complex<other_value_t> &other)
: x{static_cast<const value_t &>(other.x)}
, y{static_cast<const value_t &>(other.y)}
{}
//----------------------------------------------------------------
// operator - (negation)
//----------------------------------------------------------------
template<typename value_t>
complex<value_t> operator - (const complex<value_t> &z)
{ return {-z.x, -z.y}; }
//----------------------------------------------------------------
// operator +
//----------------------------------------------------------------
//----------------------------------------------------------------
// operator -
//----------------------------------------------------------------
//----------------------------------------------------------------
// operator *
//----------------------------------------------------------------
//----------------------------------------------------------------
// operator /
//----------------------------------------------------------------
// makes a complex<double>
auto dz = fz * 1.0;
// still a complex<double>
auto idz = 1.0f/dz;
// also a complex<double>
auto one = dz * idz;
// a complex<double> again
auto one_again = fz * idz;
return 0;
}
namespace named_operator {
template<class D>struct make_operator{constexpr make_operator(){}};
namespace my_ns {
struct append_t : named_operator::make_operator<append_t> {};
constexpr append_t append{};
std::vector<int> a {1,2,3};
std::vector<int> b {4,5,6};
auto c = a *append* b;
We then overload named_invoke( lhs, append_t, rhs ) for the types we want on the right and left.
The library overloads lhs*append_t, returning a temporary half_apply object. It also overloads half_apply*rhs to
We simply have to create the proper append_t token and do an ADL-friendly named_invoke of the proper signature,
and everything hooks up and works.
For a more complex example, suppose you want to have element-wise multiplication of elements of a std::array:
template<class=void, std::size_t...Is>
auto indexer( std::index_sequence<Is...> ) {
return [](auto&& f) {
return f( std::integral_constant<std::size_t, Is>{}... );
};
}
template<std::size_t N>
auto indexer() { return indexer( std::make_index_sequence<N>{} ); }
namespace my_ns {
struct e_times_t : named_operator::make_operator<e_times_t> {};
constexpr e_times_t e_times{};
live example.
This element-wise array code can be extended to work on tuples or pairs or C-style arrays, or even variable length
containers if you decide what to do if the lengths don't match.
You could also an element-wise operator type and get lhs *element_wise<'+'>* rhs.
Writing a *dot* and *cross* product operators are also obvious uses.
The use of * can be extended to support other delimiters, like +. The delimeter precidence determines the
precidence of the named operator, which may be important when translating physics equations over to C++ with
minimal use of extra ()s.
With a slight change in the library above, we can support ->*then* operators and extend std::function prior to
the standard being updated, or write monadic ->*bind*. It could also have a stateful named operator, where we
carefully pass the Op down to the final invoke function, permitting:
Overloading is the same for both types (++ and --). Scroll down for explanation
//Postfix operator foo++ (int argument is used to separate pre- and postfix)
//Should be implemented in terms of ++foo (prefix operator)
T operator++(T& lhs, int)
{
T t(lhs);
++lhs;
return t;
}
//Postfix operator foo++ (int argument is used to separate pre- and postfix)
//Should be implemented in terms of ++foo (prefix operator)
T operator++(int)
{
T t(*this);
++(*this);
return t;
}
Note: The prefix operator returns a reference to itself, so that you can continue operations on it. The first argument
is a reference, as the prefix operator changes the object, that's also the reason why it isn't const (you wouldn't be
able to modify it otherwise).
The postfix operator returns by value a temporary (the previous value), and so it cannot be a reference, as it would
be a reference to a temporary, which would be garbage value at the end of the function, because the temporary
variable goes out of scope). It also cannot be const, because you should be able to modify it directly.
The first argument is a non-const reference to the "calling" object, because if it were const, you wouldn't be able to
modify it, and if it weren't a reference, you wouldn't change the original value.
== and !=
> and <
>= and <=
The recommended way to overload all those operators is by implementing only 2 operators (== and <) and then
using those to define the rest. Scroll down for explanation
//Note that the functions are const, because if they are not const, you wouldn't be able
//to call them if the object is const
The operators obviously return a bool, indicating true or false for the corresponding operation.
All of the operators take their arguments by const&, because the only thing that does operators do is compare, so
they shouldn't modify the objects. Passing by & (reference) is faster than by value, and to make sure that the
operators don't modify it, it is a const-reference.
Note that the operators inside the class/struct are defined as const, the reason for this is that without the
functions being const, comparing const objects would not be possible, as the compiler doesn't know that the
If you do not overload the assignment operator for your class/struct, it is automatically generated by the
compiler: the automatically-generated assignment operator performs a "memberwise assignment", ie by invoking
assignment operators on all members, so that one object is copied to the other, a member at time. The assignment
operator should be overloaded when the simple memberwise assignment is not suitable for your class/struct, for
example if you need to perform a deep copy of an object.
Overloading the assignment operator = is easy, but you should follow some simple steps.
Note: other is passed by const&, because the object being assigned should not be changed, and passing by
reference is faster than by value, and to make sure than operator= doesn't modify it accidentally, it is const.
The assignment operator can only to be overloaded in the class/struct, because the left value of = is always the
class/struct itself. Defining it as a free function doesn't have this guarantee, and is disallowed because of that.
When you declare it in the class/struct, the left value is implicitly the class/struct itself, so there is no problem
with that.
For example:
struct Sum
{
int operator()(int a, int b)
{
return a + b;
}
};
T operator~(T lhs)
{
//Do operation
return lhs;
}
T operator~()
{
T t(*this);
//Do operation
return t;
}
Note: operator~ returns by value, because it has to return a new value (the modified value), and not a reference to
the value (it would be a reference to the temporary object, which would have garbage value in it as soon as the
operator is done). Not const either because the calling code should be able to modify it afterwards (i.e. int a = ~a
+ 1; should be possible).
Inside the class/struct you have to make a temporary object, because you can't modify this, as it would modify
the original object, which shouldn't be the case.
std::ostream overloads << to write variables to the underlying stream (example: std::cout)
std::istream overloads >> to read from the underlying stream to a variable (example: std::cin)
The way they do this is similar if you wanted to overload them "normally" outside of the class/struct, except that
specifying the arguments are not of the same type:
Example:
Vector v = { 1, 2, 3};
For a normal function, comparing two parameter types is is easy for the compiler, since it has all informat. But a
type within a template may not be determined yet. Therefore, the rule for when two parameter types are equal is
approximative here and says that the non-depependend types and values need to match and the spelling of
dependent types and expressions needs to be the same (more precisely, they need to conform to the so-called
ODR-rules), except that template parameters may be renamed. However, if under such different spellings, two
values within the types are deemed different, but will always instantiate to the same values, the overloading is
invalid, but no diagnostic is required from the compiler.
template<typename T>
void f(T*) { }
template<typename T>
void f(T) { }
This is a valid overload, as "T" and "T*" are different spellings. But the following is invalid, with no diagnostic
required
template<typename T>
void f(T (*x)[sizeof(T) + sizeof(T)]) { }
template<typename T>
void f(T (*x)[2 * sizeof(T)]) { }
class Base {
public:
virtual void foo() {
std::cout << "Base::Foo\n";
}
};
The specifier final can only be used with `virtual' member function and can't be applied to non-virtual member
functions
Like final, there is also an specifier caller 'override' which prevent overriding of virtual functions in the derived
class.
The specifiers override and final may be combined together to have desired effect:
There is no run time significance of this specifier as is mainly meant as an indication for compilers
The example below will demonstrate the change in behaviour with our without using override.
Without override:
struct X {
virtual void f() { std::cout << "X::f()\n"; }
};
struct Y : X {
// Y::f() will not override X::f() because it has a different signature,
// but the compiler will accept the code (and silently ignore Y::f()).
virtual void f(int a) { std::cout << a << "\n"; }
};
With override:
#include <iostream>
struct X {
virtual void f() { std::cout << "X::f()\n"; }
};
struct Y : X {
// The compiler will alert you to the fact that Y::f() does not
// actually override anything.
virtual void f(int a) override { std::cout << a << "\n"; }
};
Note that override is not a keyword, but a special identifier which only may appear in function signatures. In all
other contexts override still may be used as an identifier:
void foo() {
int override = 1; // OK.
int virtual = 2; // Compilation error: keywords can't be used as identifiers.
}
#include <iostream>
struct X {
virtual void f() { std::cout << "X::f()\n"; }
};
struct Y : X {
// Specifying virtual again here is optional
// because it can be inferred from X::f().
virtual void f() { std::cout << "Y::f()\n"; }
};
void call(X& a) {
a.f();
}
int main() {
X x;
Y y;
call(x); // outputs "X::f()"
call(y); // outputs "Y::f()"
#include <iostream>
struct X {
void f() { std::cout << "X::f()\n"; }
};
struct Y : X {
void f() { std::cout << "Y::f()\n"; }
};
void call(X& a) {
a.f();
}
int main() {
X x;
Y y;
call(x); // outputs "X::f()"
call(y); // outputs "X::f()"
}
#include <iostream>
using namespace std;
class base {
public:
base() { f("base constructor"); }
~base() { f("base destructor"); }
};
int main() {
derived d;
}
Output:
The reasoning behind this is that the derived class may define additional members which are not yet initialized (in
the constructor case) or already destroyed (in the destructor case), and calling its member functions would be
unsafe. Therefore during construction and destruction of C++ objects, the dynamic type of *this is considered to be
the constructor's or destructor's class and not a more-derived class.
Example:
#include <iostream>
#include <memory>
int main() {
derived d(4);
}
struct Abstract {
virtual void f() = 0;
};
struct Concrete {
void f() override {}
};
Abstract a; // Error.
Concrete c; // Good.
Even if a function is specified as pure virtual, it can be given a default implementation. Despite this, the function will
still be considered abstract, and derived classes will have to define it before they can be instantiated. In this case,
struct DefaultAbstract {
virtual void f() = 0;
};
void DefaultAbstract::f() {}
If we want to create a class that can't itself be instantiated, but doesn't prevent its derived classes from being
instantiated, we can declare the destructor as pure virtual. Being the destructor, it must be defined anyways,
if we want to be able to deallocate the instance. And as the destructor is most likely already virtual to prevent
memory leaks during polymorphic use, we won't incur an unnecessary performance hit from declaring
another function virtual. This can be useful when making interfaces.
struct Interface {
virtual ~Interface() = 0;
};
Interface::~Interface() = default;
If most or all implementations of the pure virtual function will contain duplicate code, that code can instead
be moved to the base class version, making the code easier to maintain.
class SharedBase {
State my_state;
std::unique_ptr<Helper> my_helper;
// ...
public:
virtual void config(const Context& cont) = 0;
// ...
};
/* virtual */ void SharedBase::config(const Context& cont) {
my_helper = new Helper(my_state, cont.relevant_field);
do_this();
and_that();
}
public:
void config(const Context& cont) override;
// ...
};
void OneImplementation::config(const Context& cont) /* override */ {
my_state = { cont.some_field, cont.another_field, i };
SharedBase::config(cont);
my_unique_setup();
};
struct B
{
void i_am_NOT_inlined();
};
// source (.cpp)
void B::i_am_NOT_inlined()
{
}
int main()
{
int a = 1, b = 2;
int c = add(a, b);
}
In the above code, when add is inlined, the resulting code would become something like this
int main()
{
int a = 1, b = 2;
int c = a + b;
}
The inline function is nowhere to be seen, its body gets inlined into the caller's body. Had add not been inlined, a
class C{
int i;
public:
// the default constructor definition
C()
: i(0){ // member initializer list -- initialize i to 0
// constructor function body -- can do more complex things here
}
};
Another way to satisfy the "no parameters" requirement is for the developer to provide default values for all
parameters:
class D{
int i;
int j;
public:
// also a default constructor (can be called with no parameters)
D( int i = 0, int j = 42 )
: i(i), j(j){
}
};
D d; // calls constructor of D with the provided default values for the parameters
Under some circumstances (i.e., the developer provides no constructors and there are no other disqualifying
conditions), the compiler implicitly provides an empty default constructor:
class C{
std::string s; // note: members need to be default constructible themselves
};
Having some other type of constructor is one of the disqualifying conditions mentioned earlier:
class C{
int i;
public:
C( int i ) : i(i){}
};
To prevent implicit default constructor creation, a common technique is to declare it as private (with no definition).
The intention is to cause a compile error when someone tries to use the constructor (this either results in an Access
to private error or a linker error, depending on the compiler).
To be sure a default constructor (functionally similar to the implicit one) is defined, a developer could write an
empty one explicitly.
Version ≥ c++11
In C++11, a developer can also use the delete keyword to prevent the compiler from providing a default
constructor.
class C{
int i;
public:
// default constructor is explicitly deleted
C() = delete;
};
Furthermore, a developer may also be explicit about wanting the compiler to provide a default constructor.
class C{
int i;
public:
// does have automatically generated default constructor (same as implicit one)
C() = default;
C( int i ) : i(i){}
};
You can determine whether a type has a default constructor (or is a primitive type) using
std::is_default_constructible from <type_traits>:
class C1{ };
class C2{ public: C2(){} };
class C3{ public: C3(int){} };
class C{
int* is;
string s;
public:
C()
: is( new int[10] ){
}
void f(){
C c1; // calls default constructor
C c2[2]; // calls default constructor for both elements
C* c3 = new C[2]; // calls default constructor for both array elements
C_child c_ch; // when destructed calls destructor of s_ch and of C base (and in turn s)
Under most circumstances (i.e., a user provides no destructor, and there are no other disqualifying conditions), the
compiler provides a default destructor implicitly:
class C{
int i;
string s;
};
void f(){
C* c1 = new C;
delete c1; // C has a destructor
}
class C{
int m;
private:
~C(){} // not public destructor!
};
class C_container{
C c;
};
void f(){
In C++11, a developer can override this behavior by preventing the compiler from providing a default destructor.
class C{
int m;
public:
~C() = delete; // does NOT have implicit destructor
};
void f{
C c1;
} // Compile ERROR: C has no destructor
Furthermore, a developer may also be explicit about wanting the compiler to provide a default destructor.
class C{
int m;
public:
~C() = default; // saying explicitly it does have implicit/empty destructor
};
void f(){
C c1;
} // C has a destructor -- c1 properly destroyed
Version > c++11
You can determine whether a type has a destructor (or is a primitive type) using std::is_destructible from
<type_traits>:
class C1{ };
class C2{ public: ~C2() = delete };
class C3 : public C2{ };
return *this;
}
But this approach has some problems. It fails the strong exception guarantee - if new[] throws, we've already
cleared the resources owned by this and cannot recover. We're duplicating a lot of the logic of copy construction in
copy assignment. And we have to remember the self-assignment check, which usually just adds overhead to the
copy operation, but is still critical.
To satisfy the strong exception guarantee and avoid code duplication (double so with the subsequent move
assignment operator), we can use the copy-and-swap idiom:
class person {
char* name;
int age;
public:
/* all the other functions ... */
swap(lhs.name, rhs.name);
swap(lhs.age, rhs.age);
}
person p1 = ...;
person p2 = ...;
p1 = p2;
First, we copy-construct rhs from p2 (which we didn't have to duplicate here). If that operation throws, we don't do
anything in operator= and p1 remains untouched. Next, we swap the members between *this and rhs, and then
rhs goes out of scope. When operator=, that implicitly cleans the original resources of this (via the destructor,
which we didn't have to duplicate). Self-assignment works too - it's less efficient with copy-and-swap (involves an
extra allocation and deallocation), but if that's the unlikely scenario, we don't slow down the typical use case to
account for it.
Version ≥ C++11
p1 = std::move(p2);
Here, we move-construct rhs from p2, and all the rest is just as valid. If a class is movable but not copyable, there is
no need to delete the copy-assignment, since this assignment operator will simply be ill-formed due to the deleted
copy constructor.
Furthermore, declaring move operations will suppress the generation of copy operations, so these should also be
added (if the objects of this class are required to have copy semantics).
class Movable {
public:
virtual ~Movable() noexcept = default;
class CL {
public:
void definedInside() {}
void definedOutside();
};
void CL::definedOutside() {}
These functions are called on an instance (or reference to an instance) of the class with the dot (.) operator, or a
pointer to an instance with the arrow (->) operator, and each call is tied to the instance the function was called on;
when a member function is called on an instance, it has access to all of that instance's fields (through the this
pointer), but can only access other instances' fields if those instances are supplied as parameters.
struct ST {
ST(const std::string& ss = "Wolf", int ii = 359) : s(ss), i(ii) { }
private:
std::string s;
int i;
};
ST st1;
ST st2("Species", 8472);
These functions are allowed to access member variables and/or other member functions, regardless of either the
variable or function's access modifiers. They can also be written out-of-order, accessing member variables and/or
calling member functions declared before them, as the entire class definition must be parsed before the compiler
can begin to compile a class.
class Access {
public:
Access(int i_ = 8088, int j_ = 8086, int k_ = 6502) : i(i_), j(j_), k(k_) {}
int i;
int get_k() const { return k; }
bool private_no_more() const { return i_be_private(); }
protected:
int j;
int get_i() const { return i; }
private:
int k;
int get_j() const { return j; }
bool i_be_private() const { return ((i > j) && (k < j)); }
};
class Encapsulator {
int encapsulated;
public:
int get_encapsulated() const { return encapsulated; }
void set_encapsulated(int e) { encapsulated = e; }
void some_func() {
do_something_with(encapsulated);
}
};
Inside the class, encapsulated can be freely accessed by any non-static member function; outside the class, access
to it is regulated by member functions, using get_encapsulated() to read it and set_encapsulated() to modify it.
This prevents unintentional modifications to the variable, as separate functions are used to read and write it. [There
are many discussions on whether getters and setters provide or break encapsulation, with good arguments for
both claims; such heated debate is outside the scope of this example.]
struct HiddenBase {
void f(int) { std::cout << "int" << std::endl; }
void f(bool) { std::cout << "bool" << std::endl; }
void f(std::string) { std::cout << "std::string" << std::endl; }
};
// ...
HiddenBase hb;
HidingDerived hd;
std::string s;
This is due to name resolution rules: During name lookup, once the correct name is found, we stop looking, even if
we clearly haven't found the correct version of the entity with that name (such as with hd.f(s)); due to this,
overloading the function in the derived class prevents name lookup from discovering the overloads in the base
class. To avoid this, a using-declaration can be used to "import" names from the base class into the derived class, so
// ...
HidingDerived hd;
If a derived class imports names with a using-declaration, but also declares functions with the same signature as
functions in the base class, the base class functions will silently be overridden or hidden.
struct NamesHidden {
virtual void hide_me() {}
virtual void hide_me(float) {}
void hide_me(int) {}
void hide_me(bool) {}
};
A using-declaration can also be used to change access modifiers, provided the imported entity was public or
protected in the base class.
struct ProMem {
protected:
void func() {}
};
// ...
ProMem pm;
BecomesPub bp;
Similarly, if we explicitly want to call a member function from a specific class in the inheritance hierarchy, we can
qualify the function name when calling the function, specifying that class by name.
struct One {
// ...
Three t;
struct Base {
virtual void func() { std::cout << "In Base." << std::endl; }
};
// ...
Base b;
Derived d;
Note that while pd is Base*, and rd is a Base&, calling func() on either of the two calls Derived::func() instead of
Base::func(); this is because the vtable for Derived updates the Base::func() entry to instead point to
Derived::func(). Conversely, note how passing an instance to slicer() always results in Base::func() being
called, even when the passed instance is a Derived; this is because of something known as data slicing, where
passing a Derived instance into a Base parameter by value renders the portion of the Derived instance that isn't a
Base instance inaccessible.
When a member function is defined as virtual, all derived class member functions with the same signature override
it, regardless of whether the overriding function is specified as virtual or not. This can make derived classes
harder for programmers to parse, however, as there's no indication as to which function(s) is/are virtual.
struct B {
virtual void f() {}
};
struct D : B {
void f() {} // Implicitly virtual, overrides B::f.
// You'd have to check B to know that, though.
};
Note, however, that a derived function only overrides a base function if their signatures match; even if a derived
function is explicitly declared virtual, it will instead create a new virtual function if the signatures are mismatched.
struct BadB {
virtual void f() {}
};
As of C++11, intent to override can be made explicit with the context-sensitive keyword override. This tells the
compiler that the programmer expects it to override a base class function, which causes the compiler to omit an
error if it doesn't override anything.
struct CPP11B {
virtual void f() {}
};
This also has the benefit of telling programmers that the function is both virtual, and also declared in at least one
base class, which can make complex classes easier to parse.
When a function is declared virtual, and defined outside the class definition, the virtual specifier must be
included in the function declaration, and not repeated in the definition.
Version ≥ C++11
struct VB {
virtual void f(); // "virtual" goes here.
void g();
};
/* virtual */ void VB::f() {} // Not here.
virtual void VB::g() {} // Error.
If a base class overloads a virtual function, only overloads that are explicitly specified as virtual will be virtual.
struct BOverload {
virtual void func() {}
void func(int) {}
};
// ...
const correctness, due to its nature, starts at the bottom up: Any class member function that doesn't need to
change state is declared as const, so that it can be called on const instances. This, in turn, allows passed-by-
reference parameters to be declared const when they don't need to be modified, which allows functions to take
either const or non-const objects without complaining, and const-ness can propagate outwards in this manner.
Due to this, getters are frequently const, as are any other functions that don't need to modify logical state.
class ConstIncorrect {
Field fld;
public:
ConstIncorrect(const Field& f) : fld(f) {} // Modifies.
public:
ConstCorrect(const Field& f) : fld(f) {} // Not const: Modifies.
// ...
As illustrated by the comments on ConstIncorrect and ConstCorrect, properly cv-qualifying functions also serves
as documentation. If a class is const correct, any function that isn't const can safely be assumed to change state,
and any function that is const can safely be assumed not to change state.
class A {
public:
map<string, string> * mapOfStrings;
public:
A() {
mapOfStrings = new map<string, string>();
}
void insertEntry(string const & key, string const & value) const {
(*mapOfStrings)[key] = value; // This works? Yes it does.
delete mapOfStrings; // This also works
mapOfStrings = new map<string, string>(); // This * does * not work
}
void refresh() {
delete mapOfStrings;
mapOfStrings = new map<string, string>(); // Works as refresh is non const function
}
A var;
var.insertEntry("abc", "abcValue");
var.getEntry("abc");
getchar();
return 0;
}
This flowchart was based on Mikael Persson's post. This little graphic in the flowchart is from Megan Hopkins
namespace Example
{
const int test = 5;
const int test3 = test + 3; //Fails; `test` not found outside of namespace.
Namespaces are useful for grouping related definitions together. Take the analogy of a shopping mall. Generally a
shopping mall is split up into several stores, each store selling items from a specific category. One store might sell
electronics, while another store might se