vectorStorageClientInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_VECTOR_STORGE_CLIENT_INTERFACE_HPP_INCLUDED
#define _STRUS_VECTOR_STORGE_CLIENT_INTERFACE_HPP_INCLUDED
#include "strus/wordVector.hpp"
#include "strus/vectorQueryResult.hpp"
#include <vector>
#include <string>

namespace strus {

class VectorStorageTransactionInterface;
class ValueIteratorInterface;

class VectorStorageClientInterface
{
public:
        virtual ~VectorStorageClientInterface(){}

        virtual void prepareSearch( const std::string& type)=0;

        virtual std::vector<VectorQueryResult> findSimilar( const std::string& type, const WordVector& vec, int maxNofResults, double minSimilarity, bool realVecWeights) const=0;

        virtual VectorStorageTransactionInterface* createTransaction()=0;

        virtual std::vector<std::string> types() const=0;

        virtual ValueIteratorInterface* createFeatureValueIterator() const=0;

        virtual std::vector<std::string> featureTypes( const std::string& featureValue) const=0;

        virtual int nofVectors( const std::string& type) const=0;

        virtual WordVector featureVector( const std::string& type, const std::string& featureValue) const=0;

        virtual double vectorSimilarity( const WordVector& v1, const WordVector& v2) const=0;

        virtual WordVector normalize( const WordVector& vec) const=0;

        virtual std::string config() const=0;

        virtual void close()=0;
};

}//namespace
#endif