yingjerkao / uni10

Official Repo for Uni10
28 stars 9 forks source link

Documentation should be revised #8

Open rezah opened 8 years ago

rezah commented 8 years ago

Documentation regrading UniTensor class needs to be revised,

(1) There are some errors in documentation, see the following (http://yingjerkao.github.io/uni10/doc/classuni10_1_1_uni_tensor.html#a62fb31d96ca710f8971a6126d05d869f)


uni10::UniTensor::UniTensor(const std::vector< Bond > & _bonds, std::vector< int > & labels, const std::string & _name = "" )

Create a rank-0 UniTensor with value val. Parameters

val Value of the scalar

obviously, it's not true. A lot of similar cases exist.

(2) it is not clear how to add complex matrices into blocks of UniTensor: documentation should be added.