SparseTypes.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agx/Vector.h>
#include <agx/NlmcpCallback.h>
 
namespace agx
{
  using NlmcpCallbacks = agx::Vector<NlmcpCallbackRef>;
 
  struct IndexedRangeReal
  {
    struct Trace
    {
      enum Buffer
      {
        BINARY,
        MANY_BODY,
        CONTACT,
        UNKNOWN
      };
 
      Buffer buffer;
      agx::UInt row;
    };
 
    IndexedRangeReal( agx::UInt idx, agx::RangeReal rr )
      : IndexedRangeReal( idx,
                          rr,
                          { Trace::UNKNOWN, agx::InvalidIndex } )
    {
    }
 
    IndexedRangeReal( agx::UInt idx, agx::RangeReal rr, Trace trace )
      : index( idx ),
        range( rr ),
        trace( trace )
    {
    }
 
    agx::UInt index;
    agx::RangeReal range;
    Trace trace;
 
    private:
      friend class Vector<IndexedRangeReal>;
      IndexedRangeReal()
        : IndexedRangeReal( agx::InvalidIndex,
                            RangeReal() )
      {
      }
  };
 
  class SparseRangeReal : public Vector<IndexedRangeReal>
  {
    public:
      SparseRangeReal();
 
      agx::Bool add( agx::NlmcpCallback* callback, agx::UInt localRow, agx::UInt numRows );
 
      void beginNlAddScope( agx::UInt permutedMatrixRow, agx::UInt iterativeRow );
 
      agx::UInt endNlAddScope();
 
      agx::UInt getScopePermutedMatrixRow() const;
 
      agx::UInt getScopeIterativeRow() const;
 
      agx::Bool isBoundedByNlCallback( agx::UInt row, agx::UInt searchDepth ) const;
 
      void sort();
 
      const NlmcpCallbacks& getCallbacks() const;
 
    public:
      int save_hdf5(void *group, const agx::String & name) const;
      int save_hdf5(const agx::String & filename , const agx::String & name) const;
      int load_hdf5(void *group, const agx::String & name);
      int load_hdf5(const agx::String & filename , const agx::String & name);
 
    private:
      struct NlAddScopeData
      {
        NlAddScopeData()
          : directRow( agx::InvalidIndex ),
            iterativeRow( agx::InvalidIndex ),
            numCallbacks( agx::InvalidIndex )
        {
        }
 
        agx::UInt directRow;
        agx::UInt iterativeRow;
        agx::UInt numCallbacks;
      };
 
    private:
      agx::NlmcpCallbacks m_nlCallbacks;
      NlAddScopeData m_nlAddScopeData;
  };
}