sisl.SparseOrbital
==================















.. currentmodule:: sisl

.. autoclass:: SparseOrbital







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: SparseOrbital.

      SparseOrbital.plot
      





   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      SparseOrbital.plot.atomicmatrix

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.Rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.add

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.append

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.create_construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.edges

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.eliminate_zeros

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.empty

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.finalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.fromsp

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.iter_nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.nonzero

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.prepend

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.prune_range

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.remove_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.replace

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.reset

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.spalign

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.spsame

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.sub_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.swap

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.toSparseAtom

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.tocsr

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.translate2uc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.transpose

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.untile




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.dim

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.finalized

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.nnz

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbital.shape