ForwardIndexingPolicy.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef ATHLINKS_FORWARDINDEXINGPOLICY_H
#define ATHLINKS_FORWARDINDEXINGPOLICY_H
 
 
#include "AthLinks/exceptions.h"
#include "AthLinks/tools/findInContainer.h"
#include "AthenaKernel/tools/type_tools.h"
#include "AthenaKernel/ClassName.h"
#include <cstddef>
#include <concepts>
#include <stdint.h>
 
 
namespace SG {
 

template <class CONT, class VALUE_TYPE=typename CONT::value_type>
class ForwardIndexingPolicy
{
private:
  typedef VALUE_TYPE value_type;
 
 
public:
  typedef typename type_tools::Copy<value_type>::type ElementType;
  typedef typename type_tools::Copy<value_type>::const_reference ElementConstReference;
  typedef typename type_tools::Copy<value_type>::const_pointer ElementConstPointer; 

  typedef size_t index_type;

  typedef uint32_t stored_index_type;
 
 
private:
  static const index_type INVALID = static_cast<index_type> (-1);
 
 
public:
  static bool isValid (stored_index_type index);
 

  static index_type storedToExternal (stored_index_type index);
 

  static void reset (stored_index_type& index);
 

  static ElementType lookup (index_type index, const CONT& data);
 

  static void reverseLookup(const CONT& data,
                            ElementConstReference element,
                            index_type& index);
};
 
 
} // namespace SG
 
 
#include "AthLinks/tools/ForwardIndexingPolicy.icc"
 
 
#endif // not ATHLINKS_FORWARDINDEXINGPOLICY_H