bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::ClusteringMetrics Class Reference

#include <clustering_metrics.h>

Inheritance diagram for google_bigquery_api::ClusteringMetrics:

Public Member Functions

 ClusteringMetrics (const Json::Value &storage)
 
 ClusteringMetrics (Json::Value *storage)
 
virtual ~ClusteringMetrics ()
 
const StringPiece GetTypeName () const
 
bool has_clusters () const
 
void clear_clusters ()
 
const client::JsonCppArray< Clusterget_clusters () const
 
client::JsonCppArray< Clustermutable_clusters ()
 
bool has_davies_bouldin_index () const
 
void clear_davies_bouldin_index ()
 
double get_davies_bouldin_index () const
 
void set_davies_bouldin_index (double value)
 
bool has_mean_squared_distance () const
 
void clear_mean_squared_distance ()
 
double get_mean_squared_distance () const
 
void set_mean_squared_distance (double value)
 

Static Public Member Functions

static ClusteringMetricsNew ()
 

Detailed Description

Evaluation metrics for clustering models.

Constructor & Destructor Documentation

◆ ClusteringMetrics() [1/2]

google_bigquery_api::ClusteringMetrics::ClusteringMetrics ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ClusteringMetrics() [2/2]

google_bigquery_api::ClusteringMetrics::ClusteringMetrics ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~ClusteringMetrics()

google_bigquery_api::ClusteringMetrics::~ClusteringMetrics ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_clusters()

void google_bigquery_api::ClusteringMetrics::clear_clusters ( )
inline

Clears the 'clusters' attribute.

◆ clear_davies_bouldin_index()

void google_bigquery_api::ClusteringMetrics::clear_davies_bouldin_index ( )
inline

Clears the 'daviesBouldinIndex' attribute.

◆ clear_mean_squared_distance()

void google_bigquery_api::ClusteringMetrics::clear_mean_squared_distance ( )
inline

Clears the 'meanSquaredDistance' attribute.

◆ get_clusters()

const client::JsonCppArray<Cluster > google_bigquery_api::ClusteringMetrics::get_clusters ( ) const

Get a reference to the value of the 'clusters' attribute.

◆ get_davies_bouldin_index()

double google_bigquery_api::ClusteringMetrics::get_davies_bouldin_index ( ) const
inline

Get the value of the 'daviesBouldinIndex' attribute.

◆ get_mean_squared_distance()

double google_bigquery_api::ClusteringMetrics::get_mean_squared_distance ( ) const
inline

Get the value of the 'meanSquaredDistance' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::ClusteringMetrics::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::ClusteringMetrics

◆ has_clusters()

bool google_bigquery_api::ClusteringMetrics::has_clusters ( ) const
inline

Determine if the 'clusters' attribute was set.

Returns
true if the 'clusters' attribute was set.

◆ has_davies_bouldin_index()

bool google_bigquery_api::ClusteringMetrics::has_davies_bouldin_index ( ) const
inline

Determine if the 'daviesBouldinIndex' attribute was set.

Returns
true if the 'daviesBouldinIndex' attribute was set.

◆ has_mean_squared_distance()

bool google_bigquery_api::ClusteringMetrics::has_mean_squared_distance ( ) const
inline

Determine if the 'meanSquaredDistance' attribute was set.

Returns
true if the 'meanSquaredDistance' attribute was set.

◆ mutable_clusters()

client::JsonCppArray<Cluster > google_bigquery_api::ClusteringMetrics::mutable_clusters ( )

Gets a reference to a mutable value of the 'clusters' property.

[Beta] Information for all clusters.

Returns
The result can be modified to change the attribute value.

◆ New()

ClusteringMetrics * google_bigquery_api::ClusteringMetrics::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_davies_bouldin_index()

void google_bigquery_api::ClusteringMetrics::set_davies_bouldin_index ( double  value)
inline

Change the 'daviesBouldinIndex' attribute.

Davies-Bouldin index.

Parameters
[in]valueThe new value.

◆ set_mean_squared_distance()

void google_bigquery_api::ClusteringMetrics::set_mean_squared_distance ( double  value)
inline

Change the 'meanSquaredDistance' attribute.

Mean of squared distances between each sample to its cluster centroid.

Parameters
[in]valueThe new value.

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