> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::AggregateKMeansResponse

> gpudb::AggregateKMeansResponse — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of results returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ad5a2053d2dbd8781f49d4ce47c902c3e">GPUdb::aggregateKMeans</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">gpudb/protocol/aggregate\_k\_means.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a54134c03486f60cf0ad9c3ea987ac086" id="r_a54134c03486f60cf0ad9c3ea987ac086">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a54134c03486f60cf0ad9c3ea987ac086">AggregateKMeansResponse</a> ()</td>
      </tr>

      <tr className="memdesc:a54134c03486f60cf0ad9c3ea987ac086">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateKMeansResponse" title="A set of results returned by GPUdb::aggregateKMeans.">AggregateKMeansResponse</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a54134c03486f60cf0ad9c3ea987ac086">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:ab408ce68dd6b4905271d2897d42fd0cf" id="r_ab408ce68dd6b4905271d2897d42fd0cf">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::vector\< double > > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab408ce68dd6b4905271d2897d42fd0cf">means</a></td>
      </tr>

      <tr className="memdesc:ab408ce68dd6b4905271d2897d42fd0cf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The k-mean values found. <br /></td>
      </tr>

      <tr className="separator:ab408ce68dd6b4905271d2897d42fd0cf">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ae58a3d95cf306f41b69918540ad4c4e4" id="r_ae58a3d95cf306f41b69918540ad4c4e4">
        <td className="memItemLeft" align="right" valign="top">std::vector\< int64\_t > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae58a3d95cf306f41b69918540ad4c4e4">counts</a></td>
      </tr>

      <tr className="memdesc:ae58a3d95cf306f41b69918540ad4c4e4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The number of elements in the cluster closest the corresponding k-means values. <br /></td>
      </tr>

      <tr className="separator:ae58a3d95cf306f41b69918540ad4c4e4">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a2729c6a716ad838d8b915987a2891770" id="r_a2729c6a716ad838d8b915987a2891770">
        <td className="memItemLeft" align="right" valign="top">std::vector\< double > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2729c6a716ad838d8b915987a2891770">rmsDists</a></td>
      </tr>

      <tr className="memdesc:a2729c6a716ad838d8b915987a2891770">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The root mean squared distance of the elements in the cluster for each of the k-means values. <br /></td>
      </tr>

      <tr className="separator:a2729c6a716ad838d8b915987a2891770">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad280a77fa8663a5655d5e06c78dc275f" id="r_ad280a77fa8663a5655d5e06c78dc275f">
        <td className="memItemLeft" align="right" valign="top">int64\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad280a77fa8663a5655d5e06c78dc275f">count</a></td>
      </tr>

      <tr className="memdesc:ad280a77fa8663a5655d5e06c78dc275f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The total count of all the clusters - will be the size of the input table. <br /></td>
      </tr>

      <tr className="separator:ad280a77fa8663a5655d5e06c78dc275f">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:afa9726c36dc539a56defb078338fef9f" id="r_afa9726c36dc539a56defb078338fef9f">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#afa9726c36dc539a56defb078338fef9f">rmsDist</a></td>
      </tr>

      <tr className="memdesc:afa9726c36dc539a56defb078338fef9f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The sum of all the rms\_dists - the value the k-means algorithm is attempting to minimize. <br /></td>
      </tr>

      <tr className="separator:afa9726c36dc539a56defb078338fef9f">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a9263fb4737d60266f074a2ff38ef026c" id="r_a9263fb4737d60266f074a2ff38ef026c">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9263fb4737d60266f074a2ff38ef026c">tolerance</a></td>
      </tr>

      <tr className="memdesc:a9263fb4737d60266f074a2ff38ef026c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The distance between the last two iterations of the algorithm before it quit. <br /></td>
      </tr>

      <tr className="separator:a9263fb4737d60266f074a2ff38ef026c">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a0aea47f1d7ca9c36468d172d90d44b6b" id="r_a0aea47f1d7ca9c36468d172d90d44b6b">
        <td className="memItemLeft" align="right" valign="top">int32\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0aea47f1d7ca9c36468d172d90d44b6b">numIters</a></td>
      </tr>

      <tr className="memdesc:a0aea47f1d7ca9c36468d172d90d44b6b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The number of iterations the algorithm executed before it quit. <br /></td>
      </tr>

      <tr className="separator:a0aea47f1d7ca9c36468d172d90d44b6b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a6300281c84ea017ed5a467644d25e6c3" id="r_a6300281c84ea017ed5a467644d25e6c3">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6300281c84ea017ed5a467644d25e6c3">info</a></td>
      </tr>

      <tr className="memdesc:a6300281c84ea017ed5a467644d25e6c3">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Additional information. <br /></td>
      </tr>

      <tr className="separator:a6300281c84ea017ed5a467644d25e6c3">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of results returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ad5a2053d2dbd8781f49d4ce47c902c3e">GPUdb::aggregateKMeans</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00339">339</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a54134c03486f60cf0ad9c3ea987ac086">◆ </a></span>AggregateKMeansResponse()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AggregateKMeansResponse::AggregateKMeansResponse </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateKMeansResponse" title="A set of results returned by GPUdb::aggregateKMeans.">AggregateKMeansResponse</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00345">345</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ad280a77fa8663a5655d5e06c78dc275f">◆ </a></span>count</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::AggregateKMeansResponse::count</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The total count of all the clusters - will be the size of the input table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00378">378</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae58a3d95cf306f41b69918540ad4c4e4">◆ </a></span>counts</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<int64\_t> gpudb::AggregateKMeansResponse::counts</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The number of elements in the cluster closest the corresponding k-means values. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00366">366</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a6300281c84ea017ed5a467644d25e6c3">◆ </a></span>info</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AggregateKMeansResponse::info</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Additional information. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3751e914a2b49c5dae04100e3298b086">aggregate\_k\_means\_qualified\_result\_table\_name</a>: The fully qualified name of the result table (i.e. including the schema) used to store the results. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00407">407</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab408ce68dd6b4905271d2897d42fd0cf">◆ </a></span>means</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::vector\<double> > gpudb::AggregateKMeansResponse::means</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The k-mean values found. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00360">360</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0aea47f1d7ca9c36468d172d90d44b6b">◆ </a></span>numIters</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int32\_t gpudb::AggregateKMeansResponse::numIters</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The number of iterations the algorithm executed before it quit. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00395">395</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#afa9726c36dc539a56defb078338fef9f">◆ </a></span>rmsDist</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::AggregateKMeansResponse::rmsDist</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The sum of all the rms\_dists - the value the k-means algorithm is attempting to minimize. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00384">384</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a2729c6a716ad838d8b915987a2891770">◆ </a></span>rmsDists</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<double> gpudb::AggregateKMeansResponse::rmsDists</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The root mean squared distance of the elements in the cluster for each of the k-means values. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00372">372</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9263fb4737d60266f074a2ff38ef026c">◆ </a></span>tolerance</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::AggregateKMeansResponse::tolerance</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The distance between the last two iterations of the algorithm before it quit. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source#l00390">390</a> of file <a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/aggregate__k__means_8h_source">aggregate\_k\_means.h</a></li>
    </ul>
  </div>
</div>