Struct NLEmbedding 

#[repr(C)]
pub struct NLEmbedding {
    pub ptr: Id<Object>,
}

A map of strings to vectors, which locates neighboring, similar strings.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NLEmbedding

pub fn word_embedding_for_language(language: NLLanguage) -> Option<NLEmbedding>

Retrieves a word embedding for a given language.

pub fn word_embedding_for_language_revision( language: NLLanguage, revision: UInt, ) -> Option<NLEmbedding>

Retrieves a word embedding for a given language and revision.

pub fn embedding_with_contents_of_url(url: &NSURL) -> Result<Self, NSError>

Creates a word embedding from a model file.

pub fn sentence_embedding_for_language( language: NLLanguage, ) -> Option<NLEmbedding>

Retrieves a sentence embedding for a given language.

pub fn sentence_embedding_for_language_revision( language: NLLanguage, revision: UInt, ) -> Option<NLEmbedding>

Retrieves a sentence embedding for a given language and revision.

pub fn neighbors_for_string_maximum_count_distance_type( &self, string: &NSString, max_count: UInt, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings near a string in the vocabulary.

pub fn neighbors_for_string_maximum_count_maximum_distance_distance_type( &self, string: &NSString, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings, within a radius of a string, in the vocabulary.

pub fn neighbors_for_vector_maximum_count_distance_type( &self, vector: &NSArray<NSNumber>, max_count: UInt, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings near a location in the vocabulary space.

pub fn neighbors_for_vector_maximum_count_maximum_distance_distance_type( &self, vector: &NSArray<NSNumber>, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings within a radius of a location in the vocabulary space.

pub fn enumerate_neighbors_for_string_maximum_count_distance_type_using_block<F>( &self, string: &NSString, max_count: UInt, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings of a string in the vocabulary to a block.

pub fn enumerate_neighbors_for_string_maximum_count_maximum_distance_distance_type_using_block<F>( &self, string: &NSString, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings, within a radius of a string in the vocabulary, to a block.

pub fn enumerate_neighbors_for_vector_maximum_count_distance_type_using_block<F>( &self, vector: &NSArray<NSNumber>, max_count: UInt, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings of a location in the vocabulary space to a block.

pub fn enumerate_neighbors_for_vector_maximum_count_maximum_distance_distance_type_using_block<F>( &self, vector: &NSArray<NSNumber>, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings, within a radius of a location in the vocabulary space, to a block.

pub fn distance_between_string_and_string_distance_type( &self, first: &NSString, second: &NSString, distance_type: NLDistanceType, ) -> NLDistance

Calculates the distance between two strings in the vocabulary space.

pub fn dimension(&self) -> UInt

The number of dimensions in the vocabulary’s vector space.

pub fn vocabulary_size(&self) -> UInt

The number of words in the vocabulary.

pub fn language(&self) -> Option<NLLanguage>

The language of the text in the word embedding.

pub fn contains_string(&self, string: &NSString) -> bool

Requests a Boolean value that indicates whether the term is in the vocabulary.

pub fn vector_for_string(&self, string: &NSString) -> NSArray<NSNumber>

Requests the vector for the given term.

pub fn get_vector_for_string( &self, vector: &mut [c_float], string: &NSString, ) -> bool

Copies a vector into the given a pointer to a float array.

pub fn revision(&self) -> UInt

The revision of the word embedding.

pub fn write_embedding_for_dictionary_language_revision_to_url( dictionary: &NSDictionary<NSString, NSArray<NSNumber>>, language: NLLanguage, revision: UInt, url: &NSURL, ) -> Result<bool, NSError>

Exports the word embedding contained within a Core ML model file at the given URL.

pub fn current_revision_for_language(language: NLLanguage) -> UInt

Retrieves the current version of a word embedding for the given language.

pub fn supported_revisions_for_language(language: NLLanguage) -> NSIndexSet

Retrieves all version numbers of a word embedding for the given language.

pub fn current_sentence_embedding_revision_for_language( language: NLLanguage, ) -> UInt

Retrieves the current version of a sentence embedding for the given language.

pub fn supported_sentence_embedding_revisions_for_language( language: NLLanguage, ) -> NSIndexSet

Retrieves all version numbers of a sentence embedding for the given language.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T)

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NLEmbedding

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NLEmbedding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for NLEmbedding

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for NLEmbedding

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Display for NLEmbedding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for NLEmbedding

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NLEmbedding

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

impl Hash for NLEmbedding

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl INLEmbedding for NLEmbedding

fn m_word_embedding_for_language(language: NLLanguage) -> Option<NLEmbedding>

Retrieves a word embedding for a given language.

fn m_word_embedding_for_language_revision( language: NLLanguage, revision: UInt, ) -> Option<NLEmbedding>

Retrieves a word embedding for a given language and revision.

fn m_embedding_with_contents_of_url(url: &NSURL) -> Result<Self, NSError>

where Self: Sized + FromId,

Creates a word embedding from a model file.

fn m_sentence_embedding_for_language( language: NLLanguage, ) -> Option<NLEmbedding>

Retrieves a sentence embedding for a given language.

fn m_sentence_embedding_for_language_revision( language: NLLanguage, revision: UInt, ) -> Option<NLEmbedding>

Retrieves a sentence embedding for a given language and revision.

fn m_neighbors_for_string_maximum_count_distance_type( &self, string: &NSString, max_count: UInt, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings near a string in the vocabulary.

fn m_neighbors_for_string_maximum_count_maximum_distance_distance_type( &self, string: &NSString, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings, within a radius of a string, in the vocabulary.

fn m_neighbors_for_vector_maximum_count_distance_type( &self, vector: &NSArray<NSNumber>, max_count: UInt, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings near a location in the vocabulary space.

fn m_neighbors_for_vector_maximum_count_maximum_distance_distance_type( &self, vector: &NSArray<NSNumber>, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, ) -> NSArray<NSString>

Retrieves a limited number of strings within a radius of a location in the vocabulary space.

fn m_enumerate_neighbors_for_string_maximum_count_distance_type_using_block<F>( &self, string: &NSString, max_count: UInt, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings of a string in the vocabulary to a block.

fn m_enumerate_neighbors_for_string_maximum_count_maximum_distance_distance_type_using_block<F>( &self, string: &NSString, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings, within a radius of a string in the vocabulary, to a block.

fn m_enumerate_neighbors_for_vector_maximum_count_distance_type_using_block<F>( &self, vector: &NSArray<NSNumber>, max_count: UInt, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings of a location in the vocabulary space to a block.

fn m_enumerate_neighbors_for_vector_maximum_count_maximum_distance_distance_type_using_block<F>( &self, vector: &NSArray<NSNumber>, max_count: UInt, max_distance: NLDistance, distance_type: NLDistanceType, block: F, )

where F: IntoConcreteBlock<(NSString, NLDistance, *mut bool), Ret = ()> + 'static,

Passes the nearest strings, within a radius of a location in the vocabulary space, to a block.

fn m_distance_between_string_and_string_distance_type( &self, first: &NSString, second: &NSString, distance_type: NLDistanceType, ) -> NLDistance

Calculates the distance between two strings in the vocabulary space.

fn p_dimension(&self) -> UInt

The number of dimensions in the vocabulary’s vector space.

fn p_vocabulary_size(&self) -> UInt

The number of words in the vocabulary.

fn p_language(&self) -> Option<NLLanguage>

The language of the text in the word embedding.

fn m_contains_string(&self, string: &NSString) -> bool

Requests a Boolean value that indicates whether the term is in the vocabulary.

fn m_vector_for_string(&self, string: &NSString) -> NSArray<NSNumber>

Requests the vector for the given term.

fn m_get_vector_for_string( &self, vector: &mut [c_float], string: &NSString, ) -> bool

Copies a vector into the given a pointer to a float array.

fn p_revision(&self) -> UInt

The revision of the word embedding.

fn m_write_embedding_for_dictionary_language_revision_to_url( dictionary: &NSDictionary<NSString, NSArray<NSNumber>>, language: NLLanguage, revision: UInt, url: &NSURL, ) -> Result<bool, NSError>

Exports the word embedding contained within a Core ML model file at the given URL.

fn m_current_revision_for_language(language: NLLanguage) -> UInt

Retrieves the current version of a word embedding for the given language.

fn m_supported_revisions_for_language(language: NLLanguage) -> NSIndexSet

Retrieves all version numbers of a word embedding for the given language.

fn m_current_sentence_embedding_revision_for_language( language: NLLanguage, ) -> UInt

Retrieves the current version of a sentence embedding for the given language.

fn m_supported_sentence_embedding_revisions_for_language( language: NLLanguage, ) -> NSIndexSet

Retrieves all version numbers of a sentence embedding for the given language.

impl PNSObject for NLEmbedding

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NLEmbedding

fn to_id(self) -> id

Returns id representation of the object.