index_traits.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class index_traits

#ifndef INDEX_TRAITS_H
#define INDEX_TRAITS_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef STD_LIMITS_H
#include "SheafSystem/std_limits.h"
#endif

namespace sheaf
 {
  
template <typename T>
struct SHEAF_DLL_SPEC index_traits
{
  typedef T index_type;

  typedef T pod_type;

  static inline pod_type pod(const T& xindex)
  {
    return xindex;
  };

  static inline void put_pod(T& xindex, pod_type& xpod)
  {
    xindex = xpod;
    return;
  };

  static inline T invalid()
  {
    return std::numeric_limits<T>::max();
  };

  static inline bool is_valid(const T& xindex)
  {
    return xindex != invalid();
  }

  static inline T zero()
  {
    return 0;
  };

  static inline T one()
  {
    return 1;
  };

  static inline bool is_positive(const T& xindex)
  {
    return xindex >= 0;
  }

  static inline bool is_positive_definite(const T& xindex)
  {
    return xindex > 0;
  }

  static inline T max()
  {
    return std::numeric_limits<T>::max() - 1;
  };

  static inline T min()
  {
    return std::numeric_limits<T>::min();
  };
};
 
} // namespace sheaf

#endif // ifndef INDEX_TRAITS_H