sisl.physics.Overlap
====================















.. currentmodule:: sisl.physics

.. autoclass:: Overlap







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: Overlap.

      Overlap.plot
      





   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Overlap.plot.atomicmatrix

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.Rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.Sk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.add

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.append

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.astype

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.create_construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.dSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.ddSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.edges

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.eig

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.eigh

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.eigsh

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.eliminate_zeros

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.empty

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.finalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.fromsp

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.iter_nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.iter_orbitals

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.nonzero

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.prepend

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.prune_range

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.read

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.remove_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.replace

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.reset

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.spalign

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.spsame

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.sub_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.swap

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.toSparseAtom

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.tocsr

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.translate2uc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.transpose

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.untile

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.write




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.S

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.dim

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.finalized

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.non_orthogonal

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.orthogonal

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Overlap.shape