Learn to Use ITensor

main / book / itensor_basics

ITensor Basics

The ITensor, or intelligent tensor, is the basic tensor of the ITensor library.

The simplest way to construct an ITensor is to provide its indices:

auto i = Index("index i",2);
auto j = Index("index j",3);
auto k = Index("index k",4);

auto T = ITensor(i,j,k);

This creates an ITensor T with all elements set to zero.

To confirm this is a rank 3 tensor (a tensor with 3 indices), call rank(T):

println("The rank of T is ",rank(T));
//prints: The rank of T is 3

Alternatively you can call T.r().

Click here to view a full working example
#include "itensor/all_basic.h"
using namespace itensor;

int main()
auto i = Index("index i",2);
auto j = Index("index j",3);
auto k = Index("index k",4);

auto T = ITensor(i,j,k);

println("The rank of T is ",rank(T));

return 0;

In the mathematics literature, the number of indices is often called the order of a tensor. Therefore we also provide order(T) as an alias for rank(T).

Accessing ITensor Elements

To set a particular element, or component, of an ITensor call its .set method:


This sets the i=2,j=1,k=3 element of the tensor to the value 4.56.

In a more conventional tensor interface, the above operation would look like

T(2,1,3) = 4.56; //not actual ITensor code!!

where the user would have to remember that the first entry corresponds to index i, the second to index j, and the third to index k.

For an ITensor, the reason the indices are passed to the .set method along with their values is that nothing about the ITensor interface requires knowing the index order.

If we gave the Index-value pairs such as j(2) in a different order, the .set method still accesses the correct element. A call such as


has exactly the same outcome as the call


We can retrieve an element by calling the .real method:

auto el = T.real(k(3),i(2),j(1));
println("el = ",el);
//prints: el = 4.56

This method is named "real" because it says the type of the element returned is a real number.

We can also set elements of ITensors to be complex numbers:


Now we must call the .cplx method to retrieve this element as a complex data type; calling .real would throw an exception:

auto z = T.cplx(i(2),k(3),j(1));
println("z = ",z);
//prints: z = (7,8)

Calling .cplx always succeeds even if the tensor has only real elements.

Printing ITensors

A convenient way to print an ITensor is to use the Print macro:

#include "itensor/all_basic.h"

// T = 
// ITensor r = 3: ("index i",2,Link|483) ("index j",3,Link|97) ("index k",4,Link|922)

Calling Print(expr) essentially rewrites the code to be println("expr = ",expr), which is why there is a "T = " at the beginning of the output.

The output shows the rank and all the indices, but not the ITensor elements because this could lead to a very large output.

To see the non-zero elements resulting from our earlier calls to .set, we can use the PrintData macro, which prints both the indices and the non-zero elements:

// T = 
// ITensor r = 3: ("index i",2,Link|483) ("index j",3,Link|97) ("index k",4,Link|922)
// (2,2,1) 7.00+8.00i
// (1,2,3) 4.56+0.00i

Basic Mathematical Operations

ITensors can be added, subtracted, and multiplied by scalars in the usual way:

auto Q = 2*T;
auto R = Q/3 + T*4_i;
auto S = R - T;
S *= 5;

Two ITensors can be added and subtracted if they have the same set of indices, regardless of index order. Internally, the tensor data will be permuted if the index order is different, guaranteeing the correct result.

The norm of an ITensor (square root of sum of squared elements) can be computed using the norm function

println("The norm of T is ",norm(T));

For a complete listing of all of the methods of class ITensor, view the detailed documentation.

Index Objects Contracting ITensors

Back to Book
Back to Main