00001 /******************************************************************************* 00002 Copyright (c) 2011, Yahoo! Inc. 00003 All rights reserved. 00004 00005 Redistribution and use of this software in source and binary forms, 00006 with or without modification, are permitted provided that the following 00007 conditions are met: 00008 00009 * Redistributions of source code must retain the above 00010 copyright notice, this list of conditions and the 00011 following disclaimer. 00012 00013 * Redistributions in binary form must reproduce the above 00014 copyright notice, this list of conditions and the 00015 following disclaimer in the documentation and/or other 00016 materials provided with the distribution. 00017 00018 * Neither the name of Yahoo! Inc. nor the names of its 00019 contributors may be used to endorse or promote products 00020 derived from this software without specific prior 00021 written permission of Yahoo! Inc. 00022 00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 00024 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 00025 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 00026 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 00027 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00028 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00029 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 00030 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 00031 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 00032 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00033 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00034 00035 The Initial Developer of the Original Code is Shravan Narayanamurthy. 00036 ******************************************************************************/ 00037 /* 00038 * Model_Refiner.h 00039 * 00040 * 00041 * 00042 * Created on: 23-Dec-2010 00043 * 00044 */ 00045 00046 #ifndef MODEL_REFINER_H_ 00047 #define MODEL_REFINER_H_ 00048 00049 #include "google/protobuf/message.h" 00050 00051 //!An interface that defines the necessary refinements 00052 //!for refining the LDA graphical model and its extensions. 00053 /** 00054 * A refinement is defined as an operation done to improve 00055 * the model like sampling. The definition is also extended 00056 * to operations that enable a refinement like reading documents 00057 * and evaluating log-likelihoods. 00058 * 00059 * The provider of a model's implementation has to implement 00060 * this interface suitably 00061 */ 00062 class Model_Refiner { 00063 public: 00064 virtual google::protobuf::Message* allocate_document_buffer(size_t) = 0; 00065 virtual void deallocate_document_buffer(google::protobuf::Message*) = 0; 00066 virtual google::protobuf::Message* get_nth_document( 00067 google::protobuf::Message* docs, size_t n) = 0; 00068 virtual void* read(google::protobuf::Message&) = 0; 00069 virtual void* sample(void*) = 0; 00070 virtual void* test(void*) = 0; 00071 virtual void* update(void*) = 0; 00072 virtual void* optimize(void*) = 0; 00073 virtual void* eval(void*, double&) = 0; 00074 virtual void write(void*) = 0; 00075 virtual void iteration_done() = 0; 00076 }; 00077 00078 #endif /* MODEL_REFINER_H_ */