Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

c++ template class; function with arbitrary container type, how to define it?

Okay, simple template question. Say I define my template class something like this:

template<typename T> class foo { public:     foo(T const& first, T const& second) : first(first), second(second) {}      template<typename C>     void bar(C& container, T const& baz) {         //...     } private:     T first;     T second; } 

The question is about my bar function... I need it to be able to use a standard container of some sort, which is why I included the template/typename C part, to define that container type. But apparently that's not the right way to do it, since my test class then complains that:

error: 'bar' was not declared in this scope

So how would I go about implementing my bar function the proper way? That is, as a function of my template class, with an arbitrary container type... the rest of my template class works fine (has other functions that don't result in an error), it's just that one function that's problematic.

EDIT: Okay, so the specific function (bar) is an eraseInRange function, that erases all elements in a specified range:

void eraseInRange(C& container, T const& firstElement, T const& secondElement) {...} 

And an example of how it would be used would be:

eraseInRange(v, 7, 19); 

where v is a vector in this case.

EDIT 2: Silly me! I was supposed to declare the function outside of my class, not in it... pretty frustrating mistake to be making. Anyways, thanks everyone for the help, though the problem was a little different, the information did help me construct the function, since after finding my original problem, I did get some other pleasant errors. So thank you!

like image 461
Fault Avatar asked Oct 11 '11 15:10

Fault


People also ask

How function template is defined?

Function templates are special functions that can operate with generic types. This allows us to create a function template whose functionality can be adapted to more than one type or class without repeating the entire code for each type.

How do you define a function template in CPP?

Defining a Function TemplateA function template starts with the keyword template followed by template parameter(s) inside <> which is followed by the function definition. In the above code, T is a template argument that accepts different data types ( int , float , etc.), and typename is a keyword.

What are templates How are templates used to define classes and functions?

A template allows us to create a family of classes or family of functions to handle different data types. Template classes and functions eliminate the code duplication of different data types and thus makes the development easier and faster. Multiple parameters can be used in both class and function template.

Can template function be defined in cpp file?

A template is not an actual class or function, but a "pattern" that the compiler uses to generate a family of classes or functions. In order for the compiler to generate the code, it must see both the template definition (not just declaration) and the specific types/whatever used to "fill in" the template.


1 Answers


Traits solution.

Generalize not more than needed, and not less.

In some cases that solution might not be enough as it will match any template with such signature (e.g. shared_ptr), in which case you could make use of type_traits, very much like duck-typing (templates are duck typed in general).

#include <type_traits>  // Helper to determine whether there's a const_iterator for T. template<typename T> struct has_const_iterator { private:     template<typename C> static char test(typename C::const_iterator*);     template<typename C> static int  test(...); public:     enum { value = sizeof(test<T>(0)) == sizeof(char) }; };   // bar() is defined for Containers that define const_iterator as well // as value_type. template <typename Container> typename std::enable_if<has_const_iterator<Container>::value,                         void>::type bar(const Container &c, typename Container::value_type const & t) {   // Note: no extra check needed for value_type, the check comes for   //       free in the function signature already. }   template <typename T> class DoesNotHaveConstIterator {};  #include <vector> int main () {     std::vector<float> c;     bar (c, 1.2f);      DoesNotHaveConstIterator<float> b;     bar (b, 1.2f); // correctly fails to compile } 

A good template usually does not artificially restrict the kind of types for which they are valid (why should they?). But imagine in the example above you need to have access to an objects const_iterator, then you can use SFINAE and type_traits to put those constraints on your function.


Or just to as the standard library does

Generalize not more than needed, and not less.

template <typename Iter> void bar (Iter it, Iter end) {     for (; it!=end; ++it) { /*...*/ } }  #include <vector> int main () {     std::vector<float> c;     bar (c.begin(), c.end()); } 

For more such examples, look into <algorithm>.

This approach's strength is its simplicity and is based on concepts like ForwardIterator. It will even work for arrays. If you want to report errors right in the signature, you can combine it with traits.


std containers with signature like std::vector (not recommended)

The simplest solution is approximated by Kerrek SB already, though it is invalid C++. The corrected variant goes like so:

#include <memory> // for std::allocator template <template <typename, typename> class Container,            typename Value,           typename Allocator=std::allocator<Value> > void bar(const Container<Value, Allocator> & c, const Value & t) {   // } 

However: this will only work for containers that have exactly two template type arguments, so will fail miserably for std::map (thanks Luc Danton).


Any kind of secondary template arguments (not recommended)

The corrected version for any secondary parameter count is as follows:

#include <memory> // for std::allocator<>  template <template <typename, typename...> class Container,            typename Value,           typename... AddParams > void bar(const Container<Value, AddParams...> & c, const Value & t) {   // }  template <typename T> class OneParameterVector {};  #include <vector> int main () {     OneParameterVector<float> b;     bar (b, 1.2f);     std::vector<float> c;     bar (c, 1.2f); } 

However: this will still fail for non-template containers (thanks Luc Danton).

like image 102
Sebastian Mach Avatar answered Oct 06 '22 03:10

Sebastian Mach