Coding C++ with generic functions


What is a generic function?


Download Code Example Here

A 'generic' in C++ terms is similar to an int, double, or String,  - except it means 'any type'. 
They provide a way to write code that will work with any data type - even those that haven't been defined yet. This means you can write a function that doesn't know in advance what data type you'll be putting into it so you can give it ints, doubles, or even strings. It's up to you. 

The way you declare this generic type is with the following syntax:
template <class anyClass>

So, a full function might look like this:

template <class anyClass> void swapVals(anyClass &a,anyClass &b){
  anyClass temp;
  temp = a;
  a=b;
  b=temp;
}


In this example, you can pass any 2 variables of the same type, and no matter what type they are, their values will be swapped. 

For instance, if you add this code to 

template <class anyClass> void swapVals(anyClass &a,anyClass &b){
  anyClass temp;
  temp = a;
  a=b;
  b=temp;
}

void setup() {
  // put your setup code here, to run once:
  int a = 5;
  int b = 6;
  Serial.begin(9600);
  Serial.print("a=");
  Serial.println(a);
  Serial.print("b=");
  Serial.println(b);
  // prints 
  //a=5
  //b=6
  swapVals(a,b);// swaps a and b
  Serial.begin(9600);
  Serial.print("a=");
  Serial.println(a);
  Serial.print("b=");
  Serial.println(b);
   // prints 
  //a=6
  //b=5

 
}



Why would I do this?

Well, what if you needed to do similar things with both integers and double values? You'd have to have 2 different functions with different names, so you'd need to write something like this

void swapInt(int &a,int &b){
  int temp;
  temp = a;
  a=b;
  b=temp;
}
void swapDouble(double &a,double &b){
  double temp;
  temp = a;
  a=b;
  b=temp;
}


Using generic functions, we can use the exact same code for either of  those values so you only need 1 function for any datatype. 
For instance, we can pass in doubles, or even strings to our function, and it acts exactly as expected.
So, you could do something like this, for instance:
 
void setup() {
  // put your setup code here, to run once:
  int a = 5;
  int b = 6;
  double da = 5.0;
  double db = 6.0;
  String sa = "hey";
  String sb = "there";
  
  Serial.begin(9600);
  Serial.print("a=");
  Serial.println(a);
  Serial.print("b=");
  Serial.println(b);
  Serial.print("da=");
  Serial.println(da);
  Serial.print("db=");
  Serial.println(db);
  Serial.print("sa=");
  Serial.println(sa);
  Serial.print("sb=");
  Serial.println(sb);
  // prints 
  //a=5
  //b=6
  //da=5.0
  //db=6.0
  //sa="hey"
  //sb="there"
  swapVals(a,b);// swaps a and b
  swapVals(da,db);// swaps da and db
  swapVals(sa,sb);// swaps sa and sb
 
  Serial.print("a=");
  Serial.println(a);
  Serial.print("b=");
  Serial.println(b);
  Serial.print("da=");
  Serial.println(da);
  Serial.print("db=");
  Serial.println(db);
  Serial.print("sa=");
  Serial.println(sa);
  Serial.print("sb=");
  Serial.println(sb);
  // prints 
  //a=6
  //b=5
  //da=6.0
  //db=5.0
  //sa="there"
  //sb="hey"

}








Generic functions might not always be a good fit for your project,  but they can provide a nice way to minimize your code and make it easier to make changes in the future.
As always,
Happy Coding!
~Tom



Comments

Post a Comment

Popular posts from this blog

Organize your Arduino code with header and class files

Image
Download Example Code Here Ok, so you made your awesome Arduino widget, but now you're looking at the code trying to find the spot where you made it do that cool thing, and you can't find it! There's just too much going on in the sketch file! Well my friend, it might be time for you to start organizing your code using classes and class files.  What are C++ classes? A class is basically a description of the variables and actions that something in your application might be interested in. For instance, if you were making a application involving vehicles, you might make a class that holds the speed the vehicle is currently traveling, and might have actions like drive and stop.   Something like this: class vehicle{     private:     int CurrentSpeed;     public:     void drive(int speed){          //increase the speed          CurrentSpeed = speed;      }     void ...
Read more

Using GIT with Arduino

Image
  What is GIT? The term GIT doesn't actually mean anything. It was made up. But what it is, is a "version control system". That sounds complicated, but really all it boils down to is that it saves versions of your files, and gives you a way to revert back to old versions - if necessary.  It also provides a way for multiple developers to work on the same project, and even to keep the same project 'in sync' between computers no matter where they are. Where do I get it?  In order to use GIT, you need to install it. Many IDE's come with it pre-installed, but unfortunately, the Arduino IDE does not. You can find downloads for Windows, Mac, or Linux here: https://git-scm.com/downloads I will note, however, that GIT is generally a Command-Line tool. There are GUI's also available on the same website. If you need a GUI, then you can get one there. You should first learn the basic commands for GIT before using a UI though.  Once you download and install it, you can...
Read more

Programming Arduino with Regular Expressions

Image
Download Code Here:  What is a Regular Expression? A regular expression is a string that uses characters within the string to define a pattern and provides a function to test another string to find matches to that pattern. Probably the simplest regular expression is just a string with no special characters. You can use regular expressions with Arduino by adding a third party library to your sketch. You do that using Tools->Manage Libraries Then, search for RegEx in the Library Manager. Install Regexp by clicking the install button. This will download the required files and put them into the default library location defined by your IDE. You can find the location under File->Preferences if you changed the default, but the default on Windows is C:\Users\<your_user_name>\Documents\Arduino\Libraries  If you look in your library location, you'll find a folder called Regexp that contains the required header file for this library and some other folders with the source code...
Read more