API

The following sections contains the full API documention of PyKeOps:

• Common Python API
  • LazyTensor
    • GenericLazyTensor
      • GenericLazyTensor.__init__()
      • GenericLazyTensor.lt_constructor()
      • GenericLazyTensor.get_tools()
      • GenericLazyTensor.fixvariables()
      • GenericLazyTensor.promote()
      • GenericLazyTensor.init()
      • GenericLazyTensor.join()
      • GenericLazyTensor.unary()
      • GenericLazyTensor.binary()
      • GenericLazyTensor.ternary()
      • GenericLazyTensor.reduction()
      • GenericLazyTensor.solve()
      • GenericLazyTensor.__call__()
      • GenericLazyTensor.__str__()
      • GenericLazyTensor.shape
      • GenericLazyTensor.dim()
      • GenericLazyTensor.__add__()
      • GenericLazyTensor.__radd__()
      • GenericLazyTensor.__sub__()
      • GenericLazyTensor.__rsub__()
      • GenericLazyTensor.__mul__()
      • GenericLazyTensor.__rmul__()
      • GenericLazyTensor.__truediv__()
      • GenericLazyTensor.__rtruediv__()
      • GenericLazyTensor.__or__()
      • GenericLazyTensor.__ror__()
      • GenericLazyTensor.__abs__()
      • GenericLazyTensor.abs()
      • GenericLazyTensor.__neg__()
      • GenericLazyTensor.exp()
      • GenericLazyTensor.log()
      • GenericLazyTensor.xlogx()
      • GenericLazyTensor.cos()
      • GenericLazyTensor.sin()
      • GenericLazyTensor.sinxdivx()
      • GenericLazyTensor.sinc()
      • GenericLazyTensor.asin()
      • GenericLazyTensor.acos()
      • GenericLazyTensor.atan()
      • GenericLazyTensor.atan2()
      • GenericLazyTensor.sqrt()
      • GenericLazyTensor.rsqrt()
      • GenericLazyTensor.__pow__()
      • GenericLazyTensor.power()
      • GenericLazyTensor.square()
      • GenericLazyTensor.__eq__()
      • GenericLazyTensor.__ne__()
      • GenericLazyTensor.__lt__()
      • GenericLazyTensor.__gt__()
      • GenericLazyTensor.__le__()
      • GenericLazyTensor.__ge__()
      • GenericLazyTensor.sign()
      • GenericLazyTensor.step()
      • GenericLazyTensor.relu()
      • GenericLazyTensor.clamp()
      • GenericLazyTensor.ifelse()
      • GenericLazyTensor.mod()
      • GenericLazyTensor.round()
      • GenericLazyTensor.sqnorm2()
      • GenericLazyTensor.norm2()
      • GenericLazyTensor.norm()
      • GenericLazyTensor.normalize()
      • GenericLazyTensor.sqdist()
      • GenericLazyTensor.weightedsqnorm()
      • GenericLazyTensor.weightedsqdist()
      • GenericLazyTensor.softdtw_sqdist()
      • GenericLazyTensor.elem()
      • GenericLazyTensor.extract()
      • GenericLazyTensor.__getitem__()
      • GenericLazyTensor.one_hot()
      • GenericLazyTensor.bspline()
      • GenericLazyTensor.concat()
      • GenericLazyTensor.concatenate()
      • GenericLazyTensor.cat()
      • GenericLazyTensor.matvecmult()
      • GenericLazyTensor.vecmatmult()
      • GenericLazyTensor.tensorprod()
      • GenericLazyTensor.keops_tensordot()
      • GenericLazyTensor.keops_kron()
      • GenericLazyTensor.grad()
      • GenericLazyTensor.diff()
      • GenericLazyTensor.factorize()
      • GenericLazyTensor.auto_factorize()
      • GenericLazyTensor.grad_matrix()
      • GenericLazyTensor.trace_operator()
      • GenericLazyTensor.divergence()
      • GenericLazyTensor.laplacian()
      • GenericLazyTensor.sum()
      • GenericLazyTensor.sum_reduction()
      • GenericLazyTensor.logsumexp()
      • GenericLazyTensor.logsumexp_reduction()
      • GenericLazyTensor.sumsoftmaxweight()
      • GenericLazyTensor.sumsoftmaxweight_reduction()
      • GenericLazyTensor.min()
      • GenericLazyTensor.min_reduction()
      • GenericLazyTensor.__min__()
      • GenericLazyTensor.argmin()
      • GenericLazyTensor.argmin_reduction()
      • GenericLazyTensor.min_argmin()
      • GenericLazyTensor.min_argmin_reduction()
      • GenericLazyTensor.max()
      • GenericLazyTensor.max_reduction()
      • GenericLazyTensor.__max__()
      • GenericLazyTensor.argmax()
      • GenericLazyTensor.argmax_reduction()
      • GenericLazyTensor.max_argmax()
      • GenericLazyTensor.max_argmax_reduction()
      • GenericLazyTensor.Kmin()
      • GenericLazyTensor.Kmin_reduction()
      • GenericLazyTensor.argKmin()
      • GenericLazyTensor.argKmin_reduction()
      • GenericLazyTensor.Kmin_argKmin()
      • GenericLazyTensor.Kmin_argKmin_reduction()
      • GenericLazyTensor.__matmul__()
      • GenericLazyTensor.t()
      • GenericLazyTensor.T
      • GenericLazyTensor.matvec()
      • GenericLazyTensor.rmatvec()
      • GenericLazyTensor.__hash__
      • GenericLazyTensor.__weakref__
      • GenericLazyTensor.real2complex()
      • GenericLazyTensor.imag2complex()
      • GenericLazyTensor.exp1j()
    • ComplexGenericLazyTensor
      • ComplexGenericLazyTensor.__init__()
      • ComplexGenericLazyTensor.shape
      • ComplexGenericLazyTensor.real
      • ComplexGenericLazyTensor.imag
      • ComplexGenericLazyTensor.angle()
      • ComplexGenericLazyTensor.conj()
      • ComplexGenericLazyTensor.sum()
      • ComplexGenericLazyTensor.__abs__()
      • ComplexGenericLazyTensor.exp()
      • ComplexGenericLazyTensor.real2complex()
      • ComplexGenericLazyTensor.imag2complex()
      • ComplexGenericLazyTensor.exp1j()
      • ComplexGenericLazyTensor.keops_tensordot()
      • ComplexGenericLazyTensor.__call__()
  • Utils
    • check_health()
    • clean_pykeops()
• Numpy API
  • LazyTensor
    • Vi()
    • Vj()
    • Pm()
    • LazyTensor
      • LazyTensor.__new__()
      • LazyTensor.__init__()
      • LazyTensor.get_tools()
      • LazyTensor.lt_constructor()
    • ComplexLazyTensor
      • ComplexLazyTensor.__init__()
      • ComplexLazyTensor.get_tools()
      • ComplexLazyTensor.lt_constructor()
  • Genred
    • Genred
      • Genred.__init__()
      • Genred.__call__()
  • KernelSolve
    • KernelSolve
      • KernelSolve.__init__()
      • KernelSolve.__call__()
  • Math friendly syntax
    • generic_sum()
    • generic_logsumexp()
    • generic_argmin()
    • generic_argkmin()
  • Cluster
    • cluster_centroids()
    • cluster_ranges()
    • cluster_ranges_centroids()
    • from_matrix()
    • grid_cluster()
    • sort_clusters()
    • swap_axes()
  • Tests
    • test_numpy_bindings()
• PyTorch API
  • LazyTensor
    • Vi()
    • Vj()
    • Pm()
    • LazyTensor
      • LazyTensor.__new__()
      • LazyTensor.__init__()
      • LazyTensor.get_tools()
      • LazyTensor.lt_constructor()
    • ComplexLazyTensor
      • ComplexLazyTensor.__init__()
      • ComplexLazyTensor.get_tools()
      • ComplexLazyTensor.lt_constructor()
  • Genred
    • Genred
      • Genred.__init__()
      • Genred.__call__()
  • Math friendly syntax
    • generic_sum()
    • generic_logsumexp()
    • generic_argmin()
    • generic_argkmin()
  • KernelSolve
    • KernelSolve
      • KernelSolve.__init__()
      • KernelSolve.__call__()
  • Clusters
    • cluster_centroids()
    • cluster_ranges()
    • cluster_ranges_centroids()
    • from_matrix()
    • grid_cluster()
    • sort_clusters()
    • swap_axes()
  • Tests
    • test_torch_bindings()