polar-sparse-array.h

/* Internal API: sparse array type for polar-objc.
   Copyright (C) 2022-2025 Michael Malicoat <[email protected]>
 
   This file is part of polar-objc.
 
   polar-objc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
 
   polar-objc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
   details.
 
   You should have received a copy of the GNU General Public License along with this program; see the file LICENSE.  If
   not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef POLAR_SPARSE_ARRAY_H
#define POLAR_SPARSE_ARRAY_H
// polar_sparse_array **************************************************************************************************
 
typedef struct polar_sparse_array polar_sparse_array;
typedef struct polar_sparse_array_class polar_sparse_array_class;
 
struct polar_sparse_array
{
  polar_btree data_inherited;
  void *value_element_empty;
  intptr_t idx_logical_max;
  polar_sparse_array_page page_empty;
};
 
struct polar_sparse_array_class
{
  polar_btree_class data_inherited;
};
 
#define POLAR_TYPE_SPARSE_ARRAY ( polar_sparse_array_get_type() )
 
#define POLAR_SPARSE_ARRAY(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_CAST((inst), POLAR_TYPE_SPARSE_ARRAY, polar_sparse_array) )
#define POLAR_IS_SPARSE_ARRAY(inst) ( POLAR_INTERNAL_TYPE_CHECK_INSTANCE_TYPE((inst), POLAR_TYPE_SPARSE_ARRAY) )
#define POLAR_SPARSE_ARRAY_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_CAST((klass), POLAR_TYPE_SPARSE_ARRAY, polar_sparse_array_class) )
#define POLAR_IS_SPARSE_ARRAY_CLASS(klass) ( POLAR_INTERNAL_TYPE_CHECK_CLASS_TYPE((klass), POLAR_TYPE_SPARSE_ARRAY) )
#define POLAR_SPARSE_ARRAY_GET_CLASS(inst) ( POLAR_INTERNAL_TYPE_INSTANCE_GET_CLASS((inst), POLAR_TYPE_SPARSE_ARRAY, polar_sparse_array_class) )
 
POLAR_FUNCTION_INTERNAL OBJC_FUNCTION_CONSTANT polar_internal_type
polar_sparse_array_get_type( void );
 
POLAR_FUNCTION_INTERNAL OBJC_RETURNS_VALID_POINTER polar_sparse_array *
polar_sparse_array_new( void *value_element_empty );
 
POLAR_FUNCTION_INTERNAL OBJC_FUNCTION_HOTSPOT void *
polar_sparse_array_get_element( polar_sparse_array *self, intptr_t idx_logical );
 
POLAR_FUNCTION_INTERNAL void
polar_sparse_array_set_element( polar_sparse_array **p_array_target, intptr_t idx_logical, void *value_new );
 
POLAR_FUNCTION_INTERNAL BOOL
polar_sparse_array_set_element_if_empty( polar_sparse_array **p_array_target, intptr_t idx_logical, void *value_new );
 
static inline void *
polar_sparse_array_swap_element( polar_sparse_array **p_array_target, intptr_t idx_logical, void *value_new )
{
  void *result;
 
  assert( p_array_target != NULL );
  assert( POLAR_IS_SPARSE_ARRAY(*p_array_target) );
  assert( idx_logical >= 0 );
 
  result = polar_sparse_array_get_element(*p_array_target, idx_logical);
  polar_sparse_array_set_element(p_array_target, idx_logical, value_new);
 
  return result;
}
 
static inline BOOL
polar_sparse_array_test_element_empty( polar_sparse_array *self, intptr_t idx_logical )
{
  assert( POLAR_IS_SPARSE_ARRAY(self) );
  assert( idx_logical >= 0 );
 
  return ( polar_sparse_array_get_element(self, idx_logical) == self->value_element_empty );
}
 
#endif // POLAR_SPARSE_ARRAY_H