sim.c

/*
	Ordo is program for calculating ratings of engine or chess players
    Copyright 2013 Miguel A. Ballicora

    This file is part of Ordo.

    Ordo is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Ordo is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Ordo.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <stdlib.h>
#include <stdio.h>
#include <math.h>
#include <assert.h>

#include "sim.h"
#include "encount.h"
#include "groups.h"
#include "plyrs.h"
#include "ra.h"
#include "relprior.h"
#include "randfast.h"
#include "pgnget.h"
#include "xpect.h"

#if 0
#define SAVE_SIMULATION
#define SAVE_SIMULATION_N 2
#endif

// Prototypes

static void
simulate_scores ( const double 	*ratingof_results
				, double 		deq
				, double 		wadv
				, double 		beta
				, struct GAMES *g	// output
);

static void
ratings_set_to	( double general_average	
				, const struct PLAYERS *pPlayers
				, struct RATINGS *pRA /*@out@*/
);

//----------------------------------------------------------------

void
get_a_simulated_run	( int 					limit
					, bool_t 				quiet_mode
					, double 				beta
					, double 				drawrate_evenmatch_result
					, double 				white_advantage_result

					, const struct RATINGS 			*pRA
					, const struct prior 			*PP_ori			
					, const struct rel_prior_set	*pRPset_ori 	

					, struct ENCOUNTERS 	*pEncounters 	// output
					, struct PLAYERS 		*pPlayers 		// output
					, struct GAMES 			*pGames			// output
					, struct prior 			*PP				// output
					, struct rel_prior_set	*pRPset 		// output
)
{
	int failed_sim = 0;

	relpriors_copy (pRPset_ori, pRPset); 		// reload original
	priors_copy    (PP_ori, pPlayers->n, PP); 	// reload original

	do {
		if (!quiet_mode && failed_sim > 0) 
			printf("--> Simulation: [Rejected]\n\n");

		players_flags_reset (pPlayers);
		simulate_scores ( pRA->ratingof_results
						, drawrate_evenmatch_result
						, white_advantage_result
						, beta
						, pGames /*out*/);

		relpriors_copy    (pRPset_ori, pRPset); 	// reload original
		relpriors_shuffle (pRPset);					// simulate new
		priors_copy       (PP_ori, pPlayers->n, PP);// reload original
		priors_shuffle    (PP, pPlayers->n);		// simulate new

		assert(players_have_clear_flags(pPlayers));

		encounters_calculate(ENCOUNTERS_FULL, pGames, pPlayers->flagged, pEncounters);

		players_set_priored_info (PP, pRPset, pPlayers);
		if (0 < players_set_super (quiet_mode, pEncounters, pPlayers)) {
			players_purge (quiet_mode, pPlayers);
			encounters_calculate(ENCOUNTERS_NOFLAGGED, pGames, pPlayers->flagged, pEncounters);
		}

	} while (failed_sim++ < limit && !well_connected (pEncounters, pPlayers));

	if (!quiet_mode) printf("--> Simulation: [Accepted]\n");
}

/*=== simulation routines ==========================================*/

static int
rand_threeway_wscore(double pwin, double pdraw)
{	
	long z,x,y;
	z = (long)((unsigned)(pwin * (0xffff+1)));
	x = (long)((unsigned)((pwin+pdraw) * (0xffff+1)));
	y = randfast32() & 0xffff;

	if (y < z) {
		return WHITE_WIN;
	} else if (y < x) {
		return RESULT_DRAW;
	} else {
		return BLACK_WIN;		
	}
}


// no globals
static void
simulate_scores ( const double 	*ratingof_results
				, double 		deq
				, double 		wadv
				, double 		beta
				, struct GAMES *g	// output
)
{
	gamesnum_t n_games = g->n;
	struct gamei *gam = g->ga;

	gamesnum_t i;
	player_t w, b;
	const double *rating = ratingof_results;
	double pwin, pdraw, plos;
	assert(deq <= 1 && deq >= 0);

	for (i = 0; i < n_games; i++) {
		if (gam[i].score != DISCARD) {
			w = gam[i].whiteplayer;
			b = gam[i].blackplayer;
			get_pWDL(rating[w] + wadv - rating[b], &pwin, &pdraw, &plos, deq, beta);
			gam[i].score = rand_threeway_wscore(pwin,pdraw);
		}
	}
}

/*==================================================================*/

// This section is to save simulated results for debugging purposes

static const char *Result_string[4] = {"1-0","1/2-1/2","0-1","*"};

void
save_simulated(struct PLAYERS *pPlayers, struct GAMES *pGames, int num)
{
	gamesnum_t i;
	const char *name_w;
	const char *name_b;
	const char *result;
	char filename[256] = "";	
	FILE *fout;

	sprintf (filename, "simulated_%04d.pgn", num);

	printf ("\n--> filename=%s\n\n",filename);

	if (NULL != (fout = fopen (filename, "w"))) {

		for (i = 0; i < pGames->n; i++) {

			int32_t score_i = pGames->ga[i].score;
			player_t wp_i = pGames->ga[i].whiteplayer;
			player_t bp_i = pGames->ga[i].blackplayer;

			if (score_i == DISCARD) continue;
	
			name_w = pPlayers->name [wp_i];
			name_b = pPlayers->name [bp_i];		
			result = Result_string[score_i];

			fprintf(fout,"[White \"%s\"]\n",name_w);
			fprintf(fout,"[Black \"%s\"]\n",name_b);
			fprintf(fout,"[Result \"%s\"]\n",result);
			fprintf(fout,"%s\n\n",result);
		}

		fclose(fout);
	}
}

//========================================================================
#include "sysport.h"

mythread_mutex_t Smpcount;
mythread_mutex_t Groupmtx;
mythread_mutex_t Summamtx;
mythread_mutex_t Printmtx;

static long Sim_N = 0;

static bool_t
smpcount_get (long *x)
{
	bool_t ok;
	mythread_mutex_lock (&Smpcount);
	if (Sim_N > 0) {
		*x = Sim_N--;
		ok = TRUE;
	} else {
		*x = 0;
		ok = FALSE;
	}
	mythread_mutex_unlock (&Smpcount);
	return ok;
}

static void
smpcount_set (long x)
{
	mythread_mutex_lock (&Smpcount);
	Sim_N = x;
	mythread_mutex_unlock (&Smpcount);
}

//========================================================================


struct SIMSMP {
	  long							simulate
	; bool_t 						sim_updates
	; bool_t 						quiet_mode
	; bool_t						prior_mode
	; bool_t 						adjust_white_advantage
	; bool_t 						adjust_draw_rate
	; bool_t						anchor_use
	; bool_t						anchor_err_rel2avg

	; double						general_average
	; player_t 						anchor
	; player_t						priored_n
	; double						beta

	; double 						drawrate_evenmatch_result
	; double 						white_advantage_result
	; const struct rel_prior_set *	rps
	; const struct prior *			pPrior
	; struct prior 					wa_prior
	; struct prior 					dr_prior

	; struct ENCOUNTERS	*			encount				// io, modified
	; struct PLAYERS *				plyrs				// io, modified
	; struct RATINGS *				rat					// io, modified
	; struct GAMES *				pGames				// io, modified

	; struct rel_prior_set 			RPset_work			// mem provided
	; struct prior *				PP_work				// mem provided

	; struct summations *			p_sfe_io 			// output
	;
};

//========================================================================

#include "summations.h"
#include "rtngcalc.h"

static void
ratings_set_to	( double general_average	
				, const struct PLAYERS *pPlayers
				, struct RATINGS *pRA /*@out@*/
)
{
	// may improve convergence in pathological cases, it should not be needed.
	ratings_set (pPlayers->n, general_average, pPlayers->prefed, pPlayers->flagged, pRA->ratingof);
	ratings_set (pPlayers->n, general_average, pPlayers->prefed, pPlayers->flagged, pRA->ratingbk);
	assert(ratings_sanity (pPlayers->n, pRA->ratingof));
	assert(ratings_sanity (pPlayers->n, pRA->ratingbk));
}

static void
updates_print_scale (bool_t sim_updates)
{
	if (sim_updates) {
		printf ("0   10   20   30   40   50   60   70   80   90   100 (%s)\n","%");
		printf ("|----|----|----|----|----|----|----|----|----|----|\n");
	}
}

static void
updates_print_head (bool_t quiet, long z, long simulate)
{
	mythread_mutex_lock (&Printmtx);
	if (!quiet)
		printf ("\n==> Simulation:%ld/%ld\n", z+1, simulate);
	mythread_mutex_unlock (&Printmtx);
}

static	double 					Fraction = 0.0;
static	double 					Asterisk = 1;
static	int 					Astcount = 0;

static void
updates_print_progress (bool_t sim_updates)
{
	double fraction;
	int astcount;

	mythread_mutex_lock (&Printmtx);

	fraction = Fraction;
	astcount = Astcount;
	if (sim_updates) {
		fraction += 1.0;
		while (fraction > Asterisk) {
			fraction -= Asterisk;
			astcount++;
			printf ("*"); 
		}
		fflush(stdout);
	}
	Fraction = fraction;
	Astcount = astcount;

	mythread_mutex_unlock (&Printmtx);

	return;
}

static void
updates_print_reachedgoal (bool_t sim_updates)
{
	int astcount;
	mythread_mutex_lock (&Printmtx);
	astcount = Astcount;
	if (sim_updates) {
		int x = 51-astcount;
		while (x-->0) {printf ("*"); fflush(stdout);}
		printf ("\n");
	}
	mythread_mutex_unlock (&Printmtx);
}


void
simul
	( long 							simulate
	, bool_t 						sim_updates
	, bool_t 						quiet_mode
	, bool_t						prior_mode
	, bool_t 						adjust_white_advantage
	, bool_t 						adjust_draw_rate
	, bool_t						anchor_use
	, bool_t						anchor_err_rel2avg

	, double						general_average
	, player_t 						anchor
	, player_t						priored_n
	, double						beta

	, double 						drawrate_evenmatch_result
	, double 						white_advantage_result
	, const struct rel_prior_set *	rps
	, const struct prior *			pPrior
	, struct prior 					wa_prior
	, struct prior 					dr_prior

	, struct ENCOUNTERS	*			encount				// io, modified
	, struct PLAYERS *				plyrs				// io, modified
	, struct RATINGS *				rat					// io, modified
	, struct GAMES *				pGames				// io, modified

	, struct rel_prior_set 			RPset_work			// mem provided
	, struct prior *				PP_work				// mem provided

	, struct summations *			p_sfe_io 			// output
)
{
	double 					white_advantage = white_advantage_result;
	double 					drawrate_evenmatch = drawrate_evenmatch_result;

	struct summations 		*sfe = p_sfe_io; 	// summations for errors

	struct ENCOUNTERS		Encounters = *encount;
	struct rel_prior_set 	RPset = *rps;
	struct PLAYERS 			Players = *plyrs;
	struct RATINGS 			RA = *rat;
	struct GAMES 			Games = *pGames;

	const struct prior *	PP = pPrior;

	long 					zz;
	ptrdiff_t 				topn = (ptrdiff_t)Players.n;

	assert (simulate > 1);
	if (simulate <= 1) return;

	/* Simulation block, begin */

	while (smpcount_get(&zz)) {

		long z = simulate-zz;

		if (z == 0) {
			// original run
			// should be done only once by only one thread, that is why z == 0
			mythread_mutex_lock (&Summamtx);
			sfe->wa_sum1 += white_advantage_result;
			sfe->wa_sum2 += white_advantage_result * white_advantage_result;				
			sfe->dr_sum1 += drawrate_evenmatch_result;
			sfe->dr_sum2 += drawrate_evenmatch_result * drawrate_evenmatch_result;
			mythread_mutex_unlock (&Summamtx);
		}

		updates_print_head (quiet_mode, z, simulate);

		// store originals
		relpriors_copy (&RPset, &RPset_work); 
		priors_copy (PP, Players.n, PP_work);

		mythread_mutex_lock (&Groupmtx);
		get_a_simulated_run	( 100
							, quiet_mode
							, beta
							, drawrate_evenmatch_result
							, white_advantage_result
							, &RA	
							, PP			
							, &RPset		
							, &Encounters 	// output
							, &Players		// output
							, &Games		// output
							, PP_work		// output
							, &RPset_work 	// output
							);
		mythread_mutex_unlock (&Groupmtx);

		#if defined(SAVE_SIMULATION)
		if (z+1 == SAVE_SIMULATION_N) {
			save_simulated(&Players, &Games, (int)(z+1)); 
		}
		#endif

		// may improve convergence in pathological cases, it should not be needed.
		ratings_set_to (general_average, &Players, &RA);

		Encounters.n = calc_rating 
						( quiet_mode
						, prior_mode 
						, adjust_white_advantage
						, adjust_draw_rate
						, anchor_use
						, anchor_err_rel2avg

						, general_average
						, anchor
						, priored_n
						, beta

						, &Encounters
						, &RPset_work
						, &Players
						, &RA
						, &Games

						, PP_work
						, wa_prior
						, dr_prior

						, &white_advantage
						, &drawrate_evenmatch
						);

		ratings_cleared_for_purged (&Players, &RA);

		if (anchor_err_rel2avg) {
			ratings_copy (Players.n, RA.ratingof, RA.ratingbk);	// ** save
			ratings_center_to_zero (Players.n, Players.flagged, RA.ratingof);
		}

		// update summations for errors
		mythread_mutex_lock (&Summamtx);
		summations_update (sfe, topn, RA.ratingof, white_advantage, drawrate_evenmatch);
		mythread_mutex_unlock (&Summamtx);

		if (anchor_err_rel2avg) {
			ratings_copy (Players.n, RA.ratingbk, RA.ratingof); // ** restore
		}

		updates_print_progress (sim_updates);

	} // for loop end

} /* Simulation function, end */


static /*@null@*/
thread_return_t THREAD_CALL
simul_smp_process (void *p);

#include "inidone.h"

void
simul_smp
	( int							cpus
	, long 							simulate
	, bool_t 						sim_updates
	, bool_t 						quiet_mode
	, bool_t						prior_mode
	, bool_t 						adjust_white_advantage
	, bool_t 						adjust_draw_rate
	, bool_t						anchor_use
	, bool_t						anchor_err_rel2avg

	, double						general_average
	, player_t 						anchor
	, player_t						priored_n
	, double						beta

	, double 						drawrate_evenmatch_result
	, double 						white_advantage_result
	, const struct rel_prior_set *	rps
	, const struct prior *			pPrior
	, struct prior 					wa_prior
	, struct prior 					dr_prior

	, struct ENCOUNTERS	*			encount				// io, modified
	, struct PLAYERS *				plyrs				// io, modified
	, struct RATINGS *				rat					// io, modified
	, struct GAMES *				pGames				// io, modified

	, struct rel_prior_set 			RPset_work			// mem provided
	, struct prior *				PP_work				// mem provided

	, struct summations *			p_sfe_io 			// output
)
{
	struct SIMSMP s;
	void *pdata;

	if (cpus < 1) return;

	if (cpus > 1 && !quiet_mode) {quiet_mode = TRUE; sim_updates = TRUE;}

	s.simulate					= simulate						;
	s.sim_updates				= sim_updates					;
	s.quiet_mode				= quiet_mode					;
	s.prior_mode				= prior_mode					;
	s.adjust_white_advantage	= adjust_white_advantage		;
	s.adjust_draw_rate			= adjust_draw_rate				;
	s.anchor_use				= anchor_use					;
	s.anchor_err_rel2avg		= anchor_err_rel2avg			;
	s.general_average			= general_average				;
	s.anchor					= anchor						;
	s.priored_n					= priored_n						;
	s.beta						= beta							;
	s.drawrate_evenmatch_result	= drawrate_evenmatch_result		;
	s.white_advantage_result	= white_advantage_result		;
	s.rps						= rps							;
	s.pPrior					= pPrior						;
	s.wa_prior					= wa_prior						;
	s.dr_prior					= dr_prior						;

	s.encount					= encount						;
	s.plyrs						= plyrs						;
	s.rat						= rat							;
	s.pGames					= pGames						;
	s.RPset_work				= RPset_work					;
	s.PP_work					= PP_work						;

	s.p_sfe_io 					= p_sfe_io						;

	pdata = &s; // convert to a void pointer, needed for the SMP call

	if(!summations_calloc(s.p_sfe_io, s.plyrs->n)) {
		fprintf(stderr, "Memory for simulations could not be allocated\n");
		exit(EXIT_FAILURE);
	}

	{
		#define MAX_CPUS 64

		int CPUS = cpus > MAX_CPUS? MAX_CPUS: cpus;
		int t;
		static bool_t		iret     [MAX_CPUS];
		static mythread_t 	threadid [MAX_CPUS];
		static int			err		 [MAX_CPUS];

		smpcount_set(simulate);
		updates_print_scale (sim_updates);
		Asterisk = (double)simulate/50.0;

		/* Create independent threads each of which will execute function */
		for (t = 0; t < CPUS; t++) {
			iret[t] = mythread_create( &threadid[t], simul_smp_process, pdata, &err[t]);
		}

		/* reporting error */
		for (t = 0; t < CPUS; t++) {
			if (!iret[(short int)t]) { //cast to short int silences a warning
				fprintf (stderr, "thread %d, fatal error at creating: %s\n", t, mythread_create_error(err[t]) );
				exit(EXIT_FAILURE);
			}
		}

		/* Wait for threads to be done */
		for (t = 0; t < CPUS; t++) {
			if (0==mythread_join( threadid[t] )) {
				fprintf (stderr, "thread %d: fatal problems at joining\n", t);	
				exit(EXIT_FAILURE);	
			};
		}
	}

	summations_calc_sdev (s.p_sfe_io, s.plyrs->n, (double)simulate);
	updates_print_reachedgoal (sim_updates);

	return;
}

static /*@null@*/
thread_return_t THREAD_CALL
simul_smp_process (void *p)
{
	bool_t ok;
	struct SIMSMP *s = p;

	struct PLAYERS 			_plyrs			;	
	struct ENCOUNTERS		_encount		;	
	struct GAMES 			_games			;	
	struct RATINGS 			_rat			;		
	struct prior 		*	_PP_work  = NULL;			
	struct rel_prior_set 	_RPset_work 	;	

	// save locally
	ok = TRUE;
	ok = ok && players_replicate 	(s->plyrs, &_plyrs);
	ok = ok && encounters_replicate	(s->encount, &_encount);
	ok = ok && games_replicate 		(s->pGames, &_games);
	ok = ok && ratings_replicate 	(s->rat, &_rat);	
	ok = ok && priorlist_replicate 	(s->plyrs->n, s->PP_work, &_PP_work);
	ok = ok && relpriors_replicate	(&s->RPset_work, &_RPset_work);

	if (!ok) {
		printf ("Not enough memory to run in parallel\n");
		exit(EXIT_FAILURE);
	}

	simul (	s->simulate
	, 		s->sim_updates
	, 		s->quiet_mode
	, 		s->prior_mode
	, 		s->adjust_white_advantage
	, 		s->adjust_draw_rate
	, 		s->anchor_use
	, 		s->anchor_err_rel2avg
	, 		s->general_average
	, 		s->anchor
	, 		s->priored_n
	, 		s->beta
	, 		s->drawrate_evenmatch_result
	, 		s->white_advantage_result
	, 		s->rps
	, 		s->pPrior
	, 		s->wa_prior
	, 		s->dr_prior

	, 		&_encount			// io, modified
	, 		&_plyrs				// io, modified
	, 		&_rat				// io, modified
	, 		&_games				// io, modified
	, 		_RPset_work			// mem provided
	, 		_PP_work			// mem provided

	, 		s->p_sfe_io 		// output
	);

	// done
	players_done (&_plyrs);
	encounters_done (&_encount);
	games_done (&_games);
	ratings_done (&_rat);
	priorlist_done (&_PP_work);
	relpriors_done1	(&_RPset_work);

	mythread_exit ();
	return (thread_return_t) 0;
}