sisl.SparseAtom
===============















.. currentmodule:: sisl

.. autoclass:: SparseAtom







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: SparseAtom.

      SparseAtom.plot
      





   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   
      
      SparseAtom.plot.atomicmatrix

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.Rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.create_construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.edges

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.eliminate_zeros

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.empty

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.finalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.fromsp

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.iter_nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.nonzero

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.reset

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.spalign

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.spsame

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.swap

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.tocsr

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.translate2uc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.transpose

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.untile




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.dim

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.finalized

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.nnz

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseAtom.shape