simpeg.regularization.Sparse
============================

.. currentmodule:: simpeg.regularization

.. autoclass:: Sparse
  :show-inheritance:

  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         Sparse.__call__
         Sparse.__getitem__
         Sparse.__len__
         Sparse.__mul__
         Sparse.deriv
         Sparse.deriv2
         Sparse.get_functions_of_type
         Sparse.remove_weights
         Sparse.set_weights
         Sparse.test
         Sparse.update_weights
      
         Sparse.__getitem__
         Sparse.__len__
         Sparse.__call__
         Sparse.__mul__
  

  
  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         Sparse.W
         Sparse.active_cells
         Sparse.alpha_s
         Sparse.alpha_x
         Sparse.alpha_xx
         Sparse.alpha_y
         Sparse.alpha_yy
         Sparse.alpha_z
         Sparse.alpha_zz
         Sparse.cell_weights
         Sparse.gradientType
         Sparse.gradient_type
         Sparse.indActive
         Sparse.irls_scaled
         Sparse.irls_threshold
         Sparse.length_scale_x
         Sparse.length_scale_y
         Sparse.length_scale_z
         Sparse.mapping
         Sparse.model
         Sparse.mref
         Sparse.multipliers
         Sparse.nP
         Sparse.norms
         Sparse.reference_model
         Sparse.reference_model_in_smooth
         Sparse.regularization_mesh
         Sparse.units
  
  

.. minigallery:: simpeg.regularization.Sparse
    :add-heading: Galleries and Tutorials using ``simpeg.regularization.Sparse``
    :heading-level: -