faiss/c_api/macros_impl.h
Eduardo Pinho 9efdd8d427 [C API] Additional API coverage: IndexLSH, I/O, meta-indexes (#425)
* [c_api] leverage index downcast

- make index downcast declaration+definition possible with macros
- use macros on existing index types

* [c_api] Add IndexLSH to C API

* [c_api] Add Index IO interface

- new header index_io_c.h for access to the index_io.h API
- function`faiss_write_index` and overloads for dumping index to a file
- function`faiss_read_index` and overloads for reading index from a file
- function`faiss_clone_index` for cloning an index
- update C example to save index to a file

* [c_api] Add IndexIDMap and IndexShards API
2018-05-02 13:39:59 +02:00

112 lines
4.7 KiB
C++

/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD+Patents license found in the
* LICENSE file in the root directory of this source tree.
*/
// Copyright 2004-present Facebook. All Rights Reserved.
// -*- c++ -*-
/// Utility macros for the C wrapper implementation.
#ifndef MACROS_IMPL_H
#define MACROS_IMPL_H
#include "faiss_c.h"
#include "FaissException.h"
#include "error_impl.h"
#include <stdexcept>
#include <iostream>
#ifdef NDEBUG
#define CATCH_AND_HANDLE \
catch (faiss::FaissException& e) { \
faiss_last_exception = \
std::make_exception_ptr(e); \
return -2; \
} catch (std::exception& e) { \
faiss_last_exception = \
std::make_exception_ptr(e); \
return -4; \
} catch (...) { \
faiss_last_exception = \
std::make_exception_ptr( \
std::runtime_error("Unknown error")); \
return -1; \
} return 0;
#else
#define CATCH_AND_HANDLE \
catch (faiss::FaissException& e) { \
std::cerr << e.what() << '\n'; \
faiss_last_exception = \
std::make_exception_ptr(e); \
return -2; \
} catch (std::exception& e) { \
std::cerr << e.what() << '\n'; \
faiss_last_exception = \
std::make_exception_ptr(e); \
return -4; \
} catch (...) { \
std::cerr << "Unrecognized exception!\n"; \
faiss_last_exception = \
std::make_exception_ptr( \
std::runtime_error("Unknown error")); \
return -1; \
} return 0;
#endif
#define DEFINE_GETTER(clazz, ty, name) \
ty faiss_ ## clazz ## _ ## name (const Faiss ## clazz *obj) { \
return static_cast< ty >( \
reinterpret_cast< const faiss::clazz *>(obj)-> name \
); \
}
#define DEFINE_GETTER_SUBCLASS(clazz, parent, ty, name) \
ty faiss_ ## clazz ## _ ## name (const Faiss ## clazz *obj) { \
return static_cast< ty >( \
reinterpret_cast<const faiss::parent::clazz *>(obj)-> name \
); \
}
#define DEFINE_GETTER_PERMISSIVE(clazz, ty, name) \
ty faiss_ ## clazz ## _ ## name (const Faiss ## clazz *obj) { \
return ( ty ) ( \
reinterpret_cast<const faiss::clazz *>(obj)-> name \
); \
}
#define DEFINE_GETTER_SUBCLASS_PERMISSIVE(clazz, parent, ty, name) \
ty faiss_ ## clazz ## _ ## name (const Faiss ## clazz *obj) { \
return ( ty ) ( \
reinterpret_cast<const faiss::parent::clazz *>(obj)-> name \
); \
}
#define DEFINE_SETTER(clazz, ty, name) \
void faiss_ ## clazz ## _set_ ## name (Faiss ## clazz *obj, ty val) { \
reinterpret_cast< faiss::clazz *>(obj)-> name = val; \
}
#define DEFINE_SETTER_STATIC(clazz, ty_to, ty_from, name) \
void faiss_ ## clazz ## _set_ ## name (Faiss ## clazz *obj, ty_from val) { \
reinterpret_cast< faiss::clazz *>(obj)-> name = \
static_cast< ty_to >(val); \
}
#define DEFINE_DESTRUCTOR(clazz) \
void faiss_ ## clazz ## _free (Faiss ## clazz *obj) { \
delete reinterpret_cast<faiss::clazz *>(obj); \
}
#define DEFINE_INDEX_DOWNCAST(clazz) \
Faiss ## clazz * faiss_ ## clazz ## _cast (FaissIndex* index) { \
return reinterpret_cast<Faiss ## clazz *>( \
dynamic_cast< faiss::clazz *>( \
reinterpret_cast<faiss::Index*>(index))); \
}
#endif