net::strus::api::VectorStorageClient Class Reference

Object representing a client connection to a vector storage. More...

#include <bindingObjects.hpp>

Public Member Functions
	VectorStorageClient (const VectorStorageClient &o)
	Copy constructor. More...
	~VectorStorageClient ()
	Destructor. More...
VectorStorageSearcher	createSearcher (const Index &range_from, const Index &range_to) const
	Create a searcher object for scanning the vectors for similarity. More...
VectorStorageTransaction	createTransaction ()
	Create a vector storage transaction instance. More...
StringVector	conceptClassNames () const
	Get the list of concept class names defined. More...
IndexVector	conceptFeatures (const String &conceptClass, const Index &conceptid) const
	Get the list of indices of features represented by a learnt concept feature. More...
unsigned int	nofConcepts (const String &conceptClass) const
	Get the number of concept features learned for a class. More...
IndexVector	featureConcepts (const String &conceptClass, const Index &index) const
	Get the set of learnt concepts of a class for a feature defined. More...
FloatVector	featureVector (const Index &index) const
	Get the vector assigned to a feature addressed by index. More...
String	featureName (const Index &index) const
	Get the name of a feature by its index starting from 0. More...
Index	featureIndex (const String &name) const
	Get the index starting from 0 of a feature by its name. More...
unsigned int	nofFeatures () const
	Get the number of feature vectors defined. More...
String	config () const
	Get the configuration of this model. More...
void	close ()
	Controlled close to free resources (forcing free resources in interpreter context with garbage collector) More...

Friends
class	Context

Detailed Description

Object representing a client connection to a vector storage.

Remarks

The only way to construct a vector storage client instance is to call Context::createVectorStorageClient(const std::string&)

Constructor & Destructor Documentation

net::strus::api::VectorStorageClient::VectorStorageClient

(

const VectorStorageClient &

o

)

Copy constructor.

net::strus::api::VectorStorageClient::~VectorStorageClient ( )

inline

Destructor.

Member Function Documentation

void net::strus::api::VectorStorageClient::close

(

)

Controlled close to free resources (forcing free resources in interpreter context with garbage collector)

StringVector net::strus::api::VectorStorageClient::conceptClassNames

(

)

const

Get the list of concept class names defined.

Returns

the list

IndexVector net::strus::api::VectorStorageClient::conceptFeatures	(	const String &	conceptClass,
		const Index &	conceptid
	)		const

Get the list of indices of features represented by a learnt concept feature.

Parameters

[in]	conceptClass	name identifying a class of concepts learnt
[in]	conceptid	index (indices of learnt concepts starting from 1)

Returns

the resulting vector indices (index is order of insertion starting from 0)

String net::strus::api::VectorStorageClient::config

(

)

const

Get the configuration of this model.

Returns

the configuration string

VectorStorageSearcher net::strus::api::VectorStorageClient::createSearcher	(	const Index &	range_from,
		const Index &	range_to
	)		const

Create a searcher object for scanning the vectors for similarity.

Parameters

[in]	range_from	start range of the features for the searcher (possibility to split into multiple searcher instances)
[in]	range_to	end of range of the features for the searcher (possibility to split into multiple searcher instances)

Returns

the vector search interface (with ownership)

VectorStorageTransaction net::strus::api::VectorStorageClient::createTransaction

(

)

Create a vector storage transaction instance.

IndexVector net::strus::api::VectorStorageClient::featureConcepts	(	const String &	conceptClass,
		const Index &	index
	)		const

Get the set of learnt concepts of a class for a feature defined.

Parameters

[in]	conceptClass	name identifying a class of concepts learnt
[in]	index	index of vector in the order of insertion starting from 0

Returns

the resulting concept feature indices (indices of learnt concepts starting from 1)

Index net::strus::api::VectorStorageClient::featureIndex

(

const String &

name

)

const

Get the index starting from 0 of a feature by its name.

Parameters

[in]

name

name of the feature

Returns

index -1, if not found, else index of the feature to get the name of (index is order of insertion starting with 0)

String net::strus::api::VectorStorageClient::featureName

(

const Index &

index

)

const

Get the name of a feature by its index starting from 0.

Parameters

[in]

index

index of the feature (starting from 0)

Returns

the name of the feature defined

FloatVector net::strus::api::VectorStorageClient::featureVector

(

const Index &

index

)

const

Get the vector assigned to a feature addressed by index.

Parameters

[in]

index

index of the feature (starting from 0) return the vector

unsigned int net::strus::api::VectorStorageClient::nofConcepts

(

const String &

conceptClass

)

const

Get the number of concept features learned for a class.

Parameters

[in]

conceptClass

name identifying a class of concepts learnt.

Returns

the number of concept features and also the maximum number assigned to a feature (starting with 1)

unsigned int net::strus::api::VectorStorageClient::nofFeatures

(

)

const

Get the number of feature vectors defined.

Returns

the number of features

Friends And Related Function Documentation

friend class Context

friend

---

The documentation for this class was generated from the following file:

• /home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp