C++ friend template operator overload function

在之前实现矩阵类的时候，遇到了一个问题，当时使用非成员函数重载来调用类成员函数实现了输出，这样就避开了之前的错误。后来看到了类似的问题，弄清楚了之前为什么错了。现在就总结一下错误原因和几种解决方法。

---

Problem Description：

mat.h

#ifndef _MAT_H_
#define _MAT_H_

#include <iostream>
#include <ostream>

//implement Mat class in c++

template<typename T>
class Mat{
    friend std::ostream& operator<<(std::ostream &os, const Mat& m);
public:
    //construct
    Mat() :data(0){};
    Mat(int i) :data(i){};

    //destructor
    ~Mat(){};
private:
    T data;
};

#endif

mat.cpp

#include "mat.h"

using std::cout;
using std::endl;

template<typename T>
std::ostream& operator<<(std::ostream &os, const Mat<T>& m)
{
    return os << m.data;
}

int main(){
    Mat<int> mat1;
    cout << mat1;
    return 1;
}

VS2013上编译，出现连接错误：error LNK2019: unresolved external symbol … operator<< … referenced in function _main。错误指向了 在 main 函数中调用的输出运算符，大概就是说这个输出运算符函数没有定义。可是上面我们明明定义了重载的输出运算符，错误出在哪里呢？这里问题的关键是因为我们在模板里对非成员函数也使用了模板，这样编译器就会认为这是一个新的模板。这两个模板的参数之间并没有一直性。所以在类中声明的友元函数找不到实例，因为没有针对当前类的模板类型进行实例化。这样说可能不太清楚，就直接看代码吧，有几种解决方法。

---

Solution 1：explicit reference your friend template operator overload function

只用修改 mat.h，在类定义之前，先定义”<<”的模板重载函数，因为使用到了模板类Mat< T >，所以要先前置声明 class Mat。这样就声明了一个输出元算符”<<”的模板重载函数。
注意在类友元函数声明的时候，操作符“<<”后面多了一个“ <>”，这表明现在是要使之前声明过了的一个模板函数称为友元函数。

这样的话，这个友元模板重载函数就是我们在mat.cpp中定义的函数。

#ifndef _MAT_H_
#define _MAT_H_

#include <iostream>
#include <ostream>

//implement Mat class in c++

template<typename T> class Mat;//class ahead declaration
template<typename T>
std::ostream& operator<< (std::ostream &os, const Mat<T>& m);

template<typename T>
class Mat{
    friend std::ostream& operator<< <>(std::ostream &os, const Mat& m);
public:
    //construct
    Mat() :data(0){};
    Mat(int i) :data(i){};

    //destructor
    ~Mat(){};
private:
    T data;
};

#endif

---

Solution 2：Define the friend function in the Class Declaration

除了像上面那样指定友元函数，还可以直接在类中实现友元函数的定义，这样就不用指定了。由于类中定义的函数都是 inline 类型的，对于较短的函数来说这样也是一种好方法。但是对于较复杂的函数，inline意味着会占据更多内存。

mat.h

#ifndef _MAT_H_
#define _MAT_H_

#include <iostream>
#include <ostream>

//implement Mat class in c++

template<typename T>
class Mat{
    friend std::ostream& operator<<(std::ostream &os, const Mat<T>& m){
        return os << m.data;
    }
public:
    //construct
    Mat() :data(0){};
    Mat(int i) :data(i){};

    //destructor
    ~Mat(){};
private:
    T data;
};

mat.cpp

#include "mattest.h"

using std::cout;
using std::endl;

int main(){
    Mat<int> mat1;
    cout << mat1;

    return 1;
}

---

Solution 3：Non-friend template operator overload function calling member function

这种方式就是之前文章中使用的方法，来避免使用友元函数。这种方法是比较推荐的吧。能够比较好的解决这个问题，同时代码也能很简洁。

mat.h

#ifndef _MAT_H_
#define _MAT_H_

#include <iostream>
#include <ostream>

//implement Mat class in c++

template<typename T>
class Mat{

public:
    //construct
    Mat() :data(0){};
    Mat(int i) :data(i){};

    //member function to do print job
    void CoutMat(std::ostream& os) const;

    //destructor
    ~Mat(){};
private:
    T data;
};

#endif

mat.cpp

#include "mattest.h"

using std::cout;
using std::endl;

//non-member and non-feriend overload function
template<typename T>
std::ostream& operator<<(std::ostream& os, const Mat<T>& m){
    m.CoutMat(os);//call member function
    return os;
}

//member function to do print job
template<typename T>
void Mat<T>::CoutMat(std::ostream& os) const
{
    os << data;
}

int main(){
    Mat<int> mat1;
    cout << mat1;

    return 1;
}

---

Reference

https://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Making_New_Friends