Where can I find the documents for all classes defined in ITensor?

Question

Hi

I think there is somewhere I can find the documents of all classes and functions defined in ITensor. Just like a reference or a index for head files. There I can find out the input and output parameters for a certain function. I can find some documents(Classes and Methods). But some documents are empty( like this:bondgate). Maybe somewhere else can give a full documents?

Answer 1

Hi, thanks for the question. I just added a documentation page for BondGate here:
http://itensor.org/docs.cgi?vers=cppv3&page=classes/bondgate

Please let us know if there are some other docs that you need which are missing and we will try to add them if we can.

You can also see some helpful examples of how BondGate is used and can be used such as here:
http://itensor.org/docs.cgi?vers=cppv3&page=formulas/tevol_trotter

Also, please note it's not strictly necessary to use the BondGate class to do gate-based / Trotter time evolution with ITensor. There's a tutorial code itensor/tutorial/05_gates/gates.cc which contains a nearly working example of doing such a time evolution method "from scratch" just using more basic ITensor functions and objects. The idea of the tutorial is that you are supposed to add the (two or three lines) of code that actually contracts each gate with the two-site wavefunction tensor, then test that it works. If you need help with the solution for that please just ask in a comment below.

Also if you want to post the code you are trying to make using BondGate, and have questions about that, feel free to post that too.

Best regards,
Miles

Comments

Hi Miles,

Thank you very much! It's so kind of you to do this. I will let you know if I have further questions.

Best regards,
Eric